Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > 82fd441cd3f2a8bc33fc3ed41403eced > files > 1309

python-astropy-0.2.4-4.mga4.x86_64.rpm


<!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>Values &mdash; 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="VOTable XML handling (astropy.io.votable)" href="../io/votable/index.html" />
    <link rel="next" title="Field" href="astropy.io.votable.tree.Field.html" />
    <link rel="prev" title="Info" href="astropy.io.votable.tree.Info.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.votable.tree.Field.html" title="Field">
	  next &raquo;
	</a>
      </li>
      <li class="right">
	<a href="astropy.io.votable.tree.Info.html" title="Info">
	  &laquo; previous
	</a>
	 |
      </li>
      <li>
	<a href="../index.html">Astropy v0.2.4</a>
	 &raquo;
      </li>
      <li><a href="../io/votable/index.html" accesskey="U">VOTable XML handling (<tt class="docutils literal"><span class="pre">astropy.io.votable</span></tt>)</a> &raquo;</li>
      
      <li>Values</li> 
    </ul>
</div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="id1">
<h1>Values<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="astropy.io.votable.tree.Values">
<em class="property">class </em><tt class="descclassname">astropy.io.votable.tree.</tt><tt class="descname">Values</tt><big>(</big><em>votable</em>, <em>field</em>, <em>ID=None</em>, <em>null=None</em>, <em>ref=None</em>, <em>type='legal'</em>, <em>id=None</em>, <em>config={}</em>, <em>pos=None</em>, <em>**extras</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L706" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree.Element</span></tt>, <tt class="xref py py-class docutils literal"><span class="pre">astropy.io.votable.tree._IDProperty</span></tt></p>
<p><a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC30">VALUES</a> element: used within <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC24">FIELD</a> and <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC24">PARAM</a> elements to define the domain of values.</p>
<p>The keyword arguments correspond to setting members of the same
name, documented below.</p>
<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.io.votable.tree.Values.max" title="astropy.io.votable.tree.Values.max"><tt class="xref py py-obj docutils literal"><span class="pre">max</span></tt></a></td>
<td>The maximum value of the domain.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.max_inclusive" title="astropy.io.votable.tree.Values.max_inclusive"><tt class="xref py py-obj docutils literal"><span class="pre">max_inclusive</span></tt></a></td>
<td>When <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the domain includes the maximum value.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.min" title="astropy.io.votable.tree.Values.min"><tt class="xref py py-obj docutils literal"><span class="pre">min</span></tt></a></td>
<td>The minimum value of the domain.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.min_inclusive" title="astropy.io.votable.tree.Values.min_inclusive"><tt class="xref py py-obj docutils literal"><span class="pre">min_inclusive</span></tt></a></td>
<td>When <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the domain includes the minimum value.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.null" title="astropy.io.votable.tree.Values.null"><tt class="xref py py-obj docutils literal"><span class="pre">null</span></tt></a></td>
<td>For integral datatypes, <em>null</em> is used to define the value used for missing values.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.options" title="astropy.io.votable.tree.Values.options"><tt class="xref py py-obj docutils literal"><span class="pre">options</span></tt></a></td>
<td>A list of string key-value tuples defining other OPTION elements for the domain.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.ref" title="astropy.io.votable.tree.Values.ref"><tt class="xref py py-obj docutils literal"><span class="pre">ref</span></tt></a></td>
<td>Refer to another <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC30">VALUES</a> element by <a class="reference external" href="http://www.w3.org/TR/REC-xml/#id">ID</a>, defined previously in the document, for MIN/MAX/OPTION information.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.type" title="astropy.io.votable.tree.Values.type"><tt class="xref py py-obj docutils literal"><span class="pre">type</span></tt></a></td>
<td>[<em>required</em>] Defines the applicability of the domain defined</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.io.votable.tree.Values.from_table_column" title="astropy.io.votable.tree.Values.from_table_column"><tt class="xref py py-obj docutils literal"><span class="pre">from_table_column</span></tt></a>(column)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.is_defaults" title="astropy.io.votable.tree.Values.is_defaults"><tt class="xref py py-obj docutils literal"><span class="pre">is_defaults</span></tt></a>()</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.parse" title="astropy.io.votable.tree.Values.parse"><tt class="xref py py-obj docutils literal"><span class="pre">parse</span></tt></a>(iterator,&nbsp;config)</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.to_table_column" title="astropy.io.votable.tree.Values.to_table_column"><tt class="xref py py-obj docutils literal"><span class="pre">to_table_column</span></tt></a>(column)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#astropy.io.votable.tree.Values.to_xml" title="astropy.io.votable.tree.Values.to_xml"><tt class="xref py py-obj docutils literal"><span class="pre">to_xml</span></tt></a>(w,&nbsp;**kwargs)</td>
<td></td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes Documentation</p>
<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.max">
<tt class="descname">max</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.max"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.max" title="Permalink to this definition">¶</a></dt>
<dd><p>The maximum value of the domain.  See <a class="reference internal" href="#astropy.io.votable.tree.Values.max_inclusive" title="astropy.io.votable.tree.Values.max_inclusive"><tt class="xref py py-attr docutils literal"><span class="pre">max_inclusive</span></tt></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.max_inclusive">
<tt class="descname">max_inclusive</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.max_inclusive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.max_inclusive" title="Permalink to this definition">¶</a></dt>
<dd><p>When <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the domain includes the maximum value.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.min">
<tt class="descname">min</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.min"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.min" title="Permalink to this definition">¶</a></dt>
<dd><p>The minimum value of the domain.  See <a class="reference internal" href="#astropy.io.votable.tree.Values.min_inclusive" title="astropy.io.votable.tree.Values.min_inclusive"><tt class="xref py py-attr docutils literal"><span class="pre">min_inclusive</span></tt></a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.min_inclusive">
<tt class="descname">min_inclusive</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.min_inclusive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.min_inclusive" title="Permalink to this definition">¶</a></dt>
<dd><p>When <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the domain includes the minimum value.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.null">
<tt class="descname">null</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.null"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.null" title="Permalink to this definition">¶</a></dt>
<dd><p>For integral datatypes, <em>null</em> is used to define the value
used for missing values.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.options">
<tt class="descname">options</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.options" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of string key-value tuples defining other OPTION
elements for the domain.  All options are ignored &#8211; they are
stored for round-tripping purposes only.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.ref">
<tt class="descname">ref</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.ref" title="Permalink to this definition">¶</a></dt>
<dd><p>Refer to another <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC30">VALUES</a> element by <a class="reference external" href="http://www.w3.org/TR/REC-xml/#id">ID</a>, defined previously in
the document, for MIN/MAX/OPTION information.</p>
</dd></dl>

<dl class="attribute">
<dt id="astropy.io.votable.tree.Values.type">
<tt class="descname">type</tt><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.type" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>required</em>] Defines the applicability of the domain defined
by this <a class="reference external" href="http://www.ivoa.net/Documents/REC/VOTable/VOTable-20040811.html#ToC30">VALUES</a> element.  Must be one of the following
strings:</p>
<blockquote>
<div><ul class="simple">
<li>&#8216;legal&#8217;: The domain of this column applies in general to
this datatype. (default)</li>
<li>&#8216;actual&#8217;: The domain of this column applies only to the
data enclosed in the parent table.</li>
</ul>
</div></blockquote>
</dd></dl>

<p class="rubric">Methods Documentation</p>
<dl class="method">
<dt id="astropy.io.votable.tree.Values.from_table_column">
<tt class="descname">from_table_column</tt><big>(</big><em>column</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L997" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.from_table_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.from_table_column" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="astropy.io.votable.tree.Values.is_defaults">
<tt class="descname">is_defaults</tt><big>(</big><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L938" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.is_defaults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.is_defaults" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="astropy.io.votable.tree.Values.parse">
<tt class="descname">parse</tt><big>(</big><em>iterator</em>, <em>config</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L895" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.parse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="astropy.io.votable.tree.Values.to_table_column">
<tt class="descname">to_table_column</tt><big>(</big><em>column</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L975" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.to_table_column"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.to_table_column" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="astropy.io.votable.tree.Values.to_xml">
<tt class="descname">to_xml</tt><big>(</big><em>w</em>, <em>**kwargs</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/tree.py#L944" title="Push the Edit button on the next page"><span class="edit-on-github viewcode-link">&nbsp;[edit on github]</span></a><a class="reference internal" href="../_modules/astropy/io/votable/tree.html#Values.to_xml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.tree.Values.to_xml" title="Permalink to this definition">¶</a></dt>
<dd></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="#">Values</a></li>
</ul>


        </div>
      </div>
      <div class="clearer"></div>
    </div>
<footer class="footer">
  <p class="pull-right">
    <a href="../_sources/_generated/astropy.io.votable.tree.Values.txt"
       rel="nofollow">Page Source</a> &nbsp;
    <a href="#">Back to Top</a></p>
  <p>
    &copy; Copyright 2011-2013, The Astropy Developers.<br/>
    Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. &nbsp;
    Last built 22 Oct 2013. <br/>
  </p>
</footer>
  </body>
</html>