<!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>Table — 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="Data Tables (astropy.table)" href="../table/index.html" />
<link rel="next" title="TableColumns" href="astropy.table.table.TableColumns.html" />
<link rel="prev" title="Row" href="astropy.table.table.Row.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.table.table.TableColumns.html" title="TableColumns">
next »
</a>
</li>
<li class="right">
<a href="astropy.table.table.Row.html" title="Row">
« previous
</a>
|
</li>
<li>
<a href="../index.html">Astropy v0.2.4</a>
»
</li>
<li><a href="../table/index.html" accesskey="U">Data Tables (<tt class="docutils literal"><span class="pre">astropy.table</span></tt>)</a> »</li>
<li>Table</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="table">
<h1>Table<a class="headerlink" href="#table" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="astropy.table.table.Table">
<em class="property">class </em><tt class="descclassname">astropy.table.table.</tt><tt class="descname">Table</tt><big>(</big><em>data=None</em>, <em>masked=None</em>, <em>names=None</em>, <em>dtypes=None</em>, <em>meta=None</em>, <em>copy=True</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L860" 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/table/table.html#Table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>A class to represent tables of heterogeneous data.</p>
<p><a class="reference internal" href="#astropy.table.table.Table" title="astropy.table.table.Table"><tt class="xref py py-obj docutils literal"><span class="pre">Table</span></tt></a> provides a class for heterogeneous tabular data, making use of a
<tt class="xref py py-obj docutils literal"><span class="pre">numpy</span></tt> structured array internally to store the data values. A key
enhancement provided by the <a class="reference internal" href="#astropy.table.table.Table" title="astropy.table.table.Table"><tt class="xref py py-obj docutils literal"><span class="pre">Table</span></tt></a> class is the ability to easily modify
the structure of the table by adding or removing columns, or adding new
rows of data. In addition table and column metadata are fully supported.</p>
<p><a class="reference internal" href="#astropy.table.table.Table" title="astropy.table.table.Table"><tt class="xref py py-obj docutils literal"><span class="pre">Table</span></tt></a> differs from <tt class="xref py py-obj docutils literal"><span class="pre">NDData</span></tt> by the assumption that the input data
consists of columns of homogeneous data, where each column has a unique
identifier and may contain additional metadata such as the data
units, format, and description.</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"><p class="first"><strong>data</strong> : numpy ndarray, dict, list, or Table, optional</p>
<blockquote>
<div><p>Data to initialize table.</p>
</div></blockquote>
<p><strong>masked</strong> : boolean, optional</p>
<blockquote>
<div><p>Specify whether the table is masked.</p>
</div></blockquote>
<p><strong>names</strong> : list, optional</p>
<blockquote>
<div><p>Specify column names.</p>
</div></blockquote>
<p><strong>dtypes</strong> : list, optional</p>
<blockquote>
<div><p>Specify column data types.</p>
</div></blockquote>
<p><strong>meta</strong> : dict, optional</p>
<blockquote>
<div><p>Metadata associated with the table.</p>
</div></blockquote>
<p><strong>copy</strong> : boolean, optional</p>
<blockquote class="last">
<div><p>Copy the input data (default=True).</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes Summary</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.ColumnClass" title="astropy.table.table.Table.ColumnClass"><tt class="xref py py-obj docutils literal"><span class="pre">ColumnClass</span></tt></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.colnames" title="astropy.table.table.Table.colnames"><tt class="xref py py-obj docutils literal"><span class="pre">colnames</span></tt></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.dtype" title="astropy.table.table.Table.dtype"><tt class="xref py py-obj docutils literal"><span class="pre">dtype</span></tt></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.mask" title="astropy.table.table.Table.mask"><tt class="xref py py-obj docutils literal"><span class="pre">mask</span></tt></a></td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.masked" title="astropy.table.table.Table.masked"><tt class="xref py py-obj docutils literal"><span class="pre">masked</span></tt></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.meta" title="astropy.table.table.Table.meta"><tt class="xref py py-obj docutils literal"><span class="pre">meta</span></tt></a></td>
<td></td>
</tr>
</tbody>
</table>
<p class="rubric">Methods Summary</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.add_column" title="astropy.table.table.Table.add_column"><tt class="xref py py-obj docutils literal"><span class="pre">add_column</span></tt></a>(col[, index])</td>
<td>Add a new Column object <tt class="docutils literal"><span class="pre">col</span></tt> to the table.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.add_columns" title="astropy.table.table.Table.add_columns"><tt class="xref py py-obj docutils literal"><span class="pre">add_columns</span></tt></a>(cols[, indexes])</td>
<td>Add a list of new Column objects <tt class="docutils literal"><span class="pre">cols</span></tt> to the table.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.add_row" title="astropy.table.table.Table.add_row"><tt class="xref py py-obj docutils literal"><span class="pre">add_row</span></tt></a>([vals, mask])</td>
<td>Add a new row to the end of the table.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.create_mask" title="astropy.table.table.Table.create_mask"><tt class="xref py py-obj docutils literal"><span class="pre">create_mask</span></tt></a>()</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.field" title="astropy.table.table.Table.field"><tt class="xref py py-obj docutils literal"><span class="pre">field</span></tt></a>(item)</td>
<td>Return column[item] for recarray compatibility.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.filled" title="astropy.table.table.Table.filled"><tt class="xref py py-obj docutils literal"><span class="pre">filled</span></tt></a>([fill_value])</td>
<td>Return a copy of self, with masked values filled.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.index_column" title="astropy.table.table.Table.index_column"><tt class="xref py py-obj docutils literal"><span class="pre">index_column</span></tt></a>(name)</td>
<td>Return the positional index of column <tt class="docutils literal"><span class="pre">name</span></tt>.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.keep_columns" title="astropy.table.table.Table.keep_columns"><tt class="xref py py-obj docutils literal"><span class="pre">keep_columns</span></tt></a>(names)</td>
<td>Keep only the columns specified (remove the others).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.keys" title="astropy.table.table.Table.keys"><tt class="xref py py-obj docutils literal"><span class="pre">keys</span></tt></a>()</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.more" title="astropy.table.table.Table.more"><tt class="xref py py-obj docutils literal"><span class="pre">more</span></tt></a>([max_lines, max_width, show_name, ...])</td>
<td>Interactively browse table with a paging interface.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.next" title="astropy.table.table.Table.next"><tt class="xref py py-obj docutils literal"><span class="pre">next</span></tt></a>()</td>
<td>Python 3 iterator</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.pformat" title="astropy.table.table.Table.pformat"><tt class="xref py py-obj docutils literal"><span class="pre">pformat</span></tt></a>([max_lines, max_width, show_name, ...])</td>
<td>Return a list of lines for the formatted string representation of the table.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.pprint" title="astropy.table.table.Table.pprint"><tt class="xref py py-obj docutils literal"><span class="pre">pprint</span></tt></a>([max_lines, max_width, show_name, ...])</td>
<td>Print a formatted string representation of the table.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.read" title="astropy.table.table.Table.read"><tt class="xref py py-obj docutils literal"><span class="pre">read</span></tt></a>(*args, **kwargs)</td>
<td>Read in data</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.remove_column" title="astropy.table.table.Table.remove_column"><tt class="xref py py-obj docutils literal"><span class="pre">remove_column</span></tt></a>(name)</td>
<td>Remove a column from the table.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.remove_columns" title="astropy.table.table.Table.remove_columns"><tt class="xref py py-obj docutils literal"><span class="pre">remove_columns</span></tt></a>(names)</td>
<td>Remove several columns from the table</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.rename_column" title="astropy.table.table.Table.rename_column"><tt class="xref py py-obj docutils literal"><span class="pre">rename_column</span></tt></a>(name, new_name)</td>
<td>Rename a column.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.reverse" title="astropy.table.table.Table.reverse"><tt class="xref py py-obj docutils literal"><span class="pre">reverse</span></tt></a>()</td>
<td>Reverse the row order of table rows.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.table.table.Table.sort" title="astropy.table.table.Table.sort"><tt class="xref py py-obj docutils literal"><span class="pre">sort</span></tt></a>(keys)</td>
<td>Sort the table according to one or more keys.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.table.table.Table.write" title="astropy.table.table.Table.write"><tt class="xref py py-obj docutils literal"><span class="pre">write</span></tt></a>(data, *args, **kwargs)</td>
<td>Write out data</td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes Documentation</p>
<dl class="attribute">
<dt id="astropy.table.table.Table.ColumnClass">
<tt class="descname">ColumnClass</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.ColumnClass"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.ColumnClass" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="astropy.table.table.Table.colnames">
<tt class="descname">colnames</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.colnames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.colnames" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="astropy.table.table.Table.dtype">
<tt class="descname">dtype</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.dtype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.dtype" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="astropy.table.table.Table.mask">
<tt class="descname">mask</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.mask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="astropy.table.table.Table.masked">
<tt class="descname">masked</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.masked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.masked" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="astropy.table.table.Table.meta">
<tt class="descname">meta</tt><a class="reference internal" href="../_modules/astropy/table/table.html#Table.meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.meta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<p class="rubric">Methods Documentation</p>
<dl class="method">
<dt id="astropy.table.table.Table.add_column">
<tt class="descname">add_column</tt><big>(</big><em>col</em>, <em>index=None</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1459" 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/table/table.html#Table.add_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.add_column" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new Column object <tt class="docutils literal"><span class="pre">col</span></tt> to the table. If <tt class="docutils literal"><span class="pre">index</span></tt>
is supplied then insert column before <tt class="docutils literal"><span class="pre">index</span></tt> position
in the list of columns, otherwise append column to the end
of the list.</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"><p class="first"><strong>col</strong> : Column</p>
<blockquote>
<div><p>Column object to add.</p>
</div></blockquote>
<p><strong>index</strong> : int or None</p>
<blockquote class="last">
<div><p>Insert column before this position or at end (default)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.add_columns">
<tt class="descname">add_columns</tt><big>(</big><em>cols</em>, <em>indexes=None</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1477" 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/table/table.html#Table.add_columns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.add_columns" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a list of new Column objects <tt class="docutils literal"><span class="pre">cols</span></tt> to the table. If a
corresponding list of <tt class="docutils literal"><span class="pre">indexes</span></tt> is supplied then insert column before
each <tt class="docutils literal"><span class="pre">index</span></tt> position in the <em>original</em> list of columns, otherwise
append columns to the end of the list.</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"><p class="first"><strong>cols</strong> : list of Columns</p>
<blockquote>
<div><p>Column objects to add.</p>
</div></blockquote>
<p><strong>indexes</strong> : list of ints or None</p>
<blockquote class="last">
<div><p>Insert column before this position or at end (default)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.add_row">
<tt class="descname">add_row</tt><big>(</big><em>vals=None</em>, <em>mask=None</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1607" 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/table/table.html#Table.add_row"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.add_row" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a new row to the end of the table.</p>
<p>The <tt class="docutils literal"><span class="pre">vals</span></tt> argument can be:</p>
<dl class="docutils">
<dt>sequence (e.g. tuple or list)</dt>
<dd>Column values in the same order as table columns.</dd>
<dt>mapping (e.g. dict)</dt>
<dd>Keys corresponding to column names. Missing values will be
filled with np.zeros for the column dtype.</dd>
<dt>None</dt>
<dd>All values filled with np.zeros for the column dtype.</dd>
</dl>
<p>This method requires that the Table object “owns” the underlying array
data. In particular one cannot add a row to a Table that was
initialized with copy=False from an existing array.</p>
<p>The <tt class="docutils literal"><span class="pre">mask</span></tt> attribute should give (if desired) the mask for the
values. The type of the mask should match that of the values, i.e. if
<tt class="docutils literal"><span class="pre">vals</span></tt> is an iterable, then <tt class="docutils literal"><span class="pre">mask</span></tt> should also be an iterable
with the same length, and if <tt class="docutils literal"><span class="pre">vals</span></tt> is a mapping, then <tt class="docutils literal"><span class="pre">mask</span></tt>
should be a dictionary.</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"><p class="first"><strong>vals</strong> : tuple, list, dict or None</p>
<blockquote class="last">
<div><p>Use the specified values in the new row</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.create_mask">
<tt class="descname">create_mask</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1433" 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/table/table.html#Table.create_mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.create_mask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.field">
<tt class="descname">field</tt><big>(</big><em>item</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1365" 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/table/table.html#Table.field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.field" title="Permalink to this definition">¶</a></dt>
<dd><p>Return column[item] for recarray compatibility.</p>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.filled">
<tt class="descname">filled</tt><big>(</big><em>fill_value=None</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L973" 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/table/table.html#Table.filled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.filled" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a copy of self, with masked values filled.</p>
<p>If input <tt class="docutils literal"><span class="pre">fill_value</span></tt> supplied then that value is used for all masked entries
in the table. Otherwise the individual <tt class="docutils literal"><span class="pre">fill_value</span></tt> defined for each
table column is used.</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">Returns :</th><td class="field-body"><p class="first"><strong>filled_table</strong> : Table</p>
<blockquote class="last">
<div><p>New table with masked values filled</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.index_column">
<tt class="descname">index_column</tt><big>(</big><em>name</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1440" 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/table/table.html#Table.index_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.index_column" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the positional index of column <tt class="docutils literal"><span class="pre">name</span></tt>.</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"><p class="first"><strong>name</strong> : str</p>
<blockquote>
<div><p>column name</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>index</strong> : int</p>
<blockquote class="last">
<div><p>Positional index of column <tt class="docutils literal"><span class="pre">name</span></tt>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.keep_columns">
<tt class="descname">keep_columns</tt><big>(</big><em>names</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1563" 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/table/table.html#Table.keep_columns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.keep_columns" title="Permalink to this definition">¶</a></dt>
<dd><p>Keep only the columns specified (remove the others).</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"><p class="first"><strong>names</strong> : list</p>
<blockquote class="last">
<div><p>A list containing the names of the columns to keep. All other
columns will be removed.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.keys">
<tt class="descname">keys</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1424" 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/table/table.html#Table.keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.keys" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.more">
<tt class="descname">more</tt><big>(</big><em>max_lines=None</em>, <em>max_width=None</em>, <em>show_name=True</em>, <em>show_units=False</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1270" 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/table/table.html#Table.more"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.more" title="Permalink to this definition">¶</a></dt>
<dd><p>Interactively browse table with a paging interface.</p>
<p>Supported keys:</p>
<div class="highlight-python"><pre>f, <space> : forward one page
b : back one page
r : refresh same page
n : next row
p : previous row
< : go to beginning
> : go to end
q : quit browsing
h : print this help</pre>
</div>
<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"><p class="first"><strong>max_lines</strong> : int</p>
<blockquote>
<div><p>Maximum number of lines in table output</p>
</div></blockquote>
<p><strong>max_width</strong> : int or None</p>
<blockquote>
<div><p>Maximum character width of output</p>
</div></blockquote>
<p><strong>show_name</strong> : bool</p>
<blockquote>
<div><p>Include a header row for column names (default=True)</p>
</div></blockquote>
<p><strong>show_units</strong> : bool</p>
<blockquote class="last">
<div><p>Include a header row for units (default=False)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.next">
<tt class="descname">next</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1353" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="headerlink" href="#astropy.table.table.Table.next" title="Permalink to this definition">¶</a></dt>
<dd><p>Python 3 iterator</p>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.pformat">
<tt class="descname">pformat</tt><big>(</big><em>max_lines=None</em>, <em>max_width=None</em>, <em>show_name=True</em>, <em>show_units=False</em>, <em>html=False</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1230" 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/table/table.html#Table.pformat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.pformat" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of lines for the formatted string representation of
the table.</p>
<p>If no value of <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt> is supplied then the height of the screen
terminal is used to set <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt>. If the terminal height cannot
be determined then the default is taken from the configuration item
<tt class="xref py py-obj docutils literal"><span class="pre">astropy.table.pprint.MAX_LINES</span></tt>. If a negative value of <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt>
is supplied then there is no line limit applied.</p>
<p>The same applies for max_width except the configuration item is
<tt class="xref py py-obj docutils literal"><span class="pre">astropy.table.pprint.MAX_WIDTH</span></tt>.</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"><p class="first"><strong>max_lines</strong> : int or None</p>
<blockquote>
<div><p>Maximum number of rows to output</p>
</div></blockquote>
<p><strong>max_width</strong> : int or None</p>
<blockquote>
<div><p>Maximum character width of output</p>
</div></blockquote>
<p><strong>show_name</strong> : bool</p>
<blockquote>
<div><p>Include a header row for column names (default=True)</p>
</div></blockquote>
<p><strong>show_units</strong> : bool</p>
<blockquote>
<div><p>Include a header row for units (default=False)</p>
</div></blockquote>
<p><strong>html</strong> : bool</p>
<blockquote>
<div><p>Format the output as an HTML table (default=False)</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>lines</strong> : list</p>
<blockquote class="last">
<div><p>Formatted table as a list of strings</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.pprint">
<tt class="descname">pprint</tt><big>(</big><em>max_lines=None</em>, <em>max_width=None</em>, <em>show_name=True</em>, <em>show_units=False</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1194" 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/table/table.html#Table.pprint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.pprint" title="Permalink to this definition">¶</a></dt>
<dd><p>Print a formatted string representation of the table.</p>
<p>If no value of <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt> is supplied then the height of the screen
terminal is used to set <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt>. If the terminal height cannot
be determined then the default is taken from the configuration item
<tt class="xref py py-obj docutils literal"><span class="pre">astropy.table.pprint.MAX_LINES</span></tt>. If a negative value of <tt class="xref py py-obj docutils literal"><span class="pre">max_lines</span></tt>
is supplied then there is no line limit applied.</p>
<p>The same applies for max_width except the configuration item is
<tt class="xref py py-obj docutils literal"><span class="pre">astropy.table.pprint.MAX_WIDTH</span></tt>.</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"><p class="first"><strong>max_lines</strong> : int</p>
<blockquote>
<div><p>Maximum number of lines in table output</p>
</div></blockquote>
<p><strong>max_width</strong> : int or None</p>
<blockquote>
<div><p>Maximum character width of output</p>
</div></blockquote>
<p><strong>show_name</strong> : bool</p>
<blockquote>
<div><p>Include a header row for column names (default=True)</p>
</div></blockquote>
<p><strong>show_units</strong> : bool</p>
<blockquote class="last">
<div><p>Include a header row for units (default=False)</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="classmethod">
<dt id="astropy.table.table.Table.read">
<em class="property">classmethod </em><tt class="descname">read</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L141" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="headerlink" href="#astropy.table.table.Table.read" title="Permalink to this definition">¶</a></dt>
<dd><p>Read in data</p>
<p>The arguments passed to this method depend on the format</p>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.remove_column">
<tt class="descname">remove_column</tt><big>(</big><em>name</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1509" 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/table/table.html#Table.remove_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.remove_column" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a column from the table.</p>
<p>This can also be done with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">del</span> <span class="n">table</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
</pre></div>
</div>
<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"><p class="first"><strong>name</strong> : str</p>
<blockquote class="last">
<div><p>Name of column to remove</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.remove_columns">
<tt class="descname">remove_columns</tt><big>(</big><em>names</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1525" 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/table/table.html#Table.remove_columns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.remove_columns" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove several columns from the table</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"><p class="first"><strong>names</strong> : list</p>
<blockquote class="last">
<div><p>A list containing the names of the columns to remove</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.rename_column">
<tt class="descname">rename_column</tt><big>(</big><em>name</em>, <em>new_name</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1585" 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/table/table.html#Table.rename_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.rename_column" title="Permalink to this definition">¶</a></dt>
<dd><p>Rename a column.</p>
<p>This can also be done directly with by setting the <tt class="docutils literal"><span class="pre">name</span></tt> attribute
for a column:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">table</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">new_name</span>
</pre></div>
</div>
<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"><p class="first"><strong>name</strong> : str</p>
<blockquote>
<div><p>The current name of the column.</p>
</div></blockquote>
<p><strong>new_name</strong> : str</p>
<blockquote class="last">
<div><p>The new name for the column</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.reverse">
<tt class="descname">reverse</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1725" 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/table/table.html#Table.reverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.reverse" title="Permalink to this definition">¶</a></dt>
<dd><p>Reverse the row order of table rows. The table is reversed
in place and there are no function arguments.</p>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.sort">
<tt class="descname">sort</tt><big>(</big><em>keys</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L1710" 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/table/table.html#Table.sort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.table.table.Table.sort" title="Permalink to this definition">¶</a></dt>
<dd><p>Sort the table according to one or more keys. This operates
on the existing table and does not return a new table.</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"><p class="first"><strong>keys</strong> : str or list of str</p>
<blockquote class="last">
<div><p>The key(s) to order the table by</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="astropy.table.table.Table.write">
<tt class="descname">write</tt><big>(</big><em>data</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/table/table.py#L184" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link"> [edit on github]</span></a><a class="headerlink" href="#astropy.table.table.Table.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Write out data</p>
<p>The arguments passed to this method depend on the format</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><h3>Page Contents</h3>
<ul>
<li><a class="reference internal" href="#">Table</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/_generated/astropy.table.table.Table.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>
