<!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>parse_ucd — 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="check_ucd" href="astropy.io.votable.ucd.check_ucd.html" />
<link rel="prev" title="Converter" href="astropy.io.votable.converters.Converter.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.ucd.check_ucd.html" title="check_ucd">
next »
</a>
</li>
<li class="right">
<a href="astropy.io.votable.converters.Converter.html" title="Converter">
« previous
</a>
|
</li>
<li>
<a href="../index.html">Astropy v0.2.4</a>
»
</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> »</li>
<li>parse_ucd</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="parse-ucd">
<h1>parse_ucd<a class="headerlink" href="#parse-ucd" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="astropy.io.votable.ucd.parse_ucd">
<tt class="descclassname">astropy.io.votable.ucd.</tt><tt class="descname">parse_ucd</tt><big>(</big><em>ucd</em>, <em>check_controlled_vocabulary=False</em>, <em>has_colon=False</em><big>)</big><a class="reference external" href="http://github.com/astropy/astropy/tree/v0.2.4/astropy/io/votable/ucd.py#L71" 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/votable/ucd.html#parse_ucd"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#astropy.io.votable.ucd.parse_ucd" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse the UCD into its component parts.</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>ucd</strong> : str</p>
<blockquote>
<div><p>The UCD string</p>
</div></blockquote>
<p><strong>check_controlled_vocabulary</strong> : bool, optional</p>
<blockquote>
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, then each word in the UCD will be verified against
the UCD1+ controlled vocabulary, (as required by the VOTable
specification version 1.2), otherwise not.</p>
</div></blockquote>
<p><strong>has_colon</strong> : bool, optional</p>
<blockquote>
<div><p>If <tt class="xref py py-obj docutils literal"><span class="pre">True</span></tt>, the UCD may contain a colon (as defined in earlier
versions of the standard).</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns :</th><td class="field-body"><p class="first"><strong>parts</strong> : list</p>
<blockquote>
<div><p>The result is a list of tuples of the form:</p>
<blockquote>
<div><p>(<em>namespace</em>, <em>word</em>)</p>
</div></blockquote>
<p>If no namespace was explicitly specified, <em>namespace</em> will be
returned as <tt class="docutils literal"><span class="pre">'ivoa'</span></tt> (i.e., the default namespace).</p>
</div></blockquote>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><p class="first last"><strong>ValueError</strong> : <em>ucd</em> is invalid</p>
</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="#">parse_ucd</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<footer class="footer">
<p class="pull-right">
<a href="../_sources/_generated/astropy.io.votable.ucd.parse_ucd.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>
