/docs/1.1.10/generated/cf.AuxiliaryCoordinate.name.html
HTML | 243 lines | 199 code | 14 blank | 30 comment | 0 complexity | 3a82139c40a86e39a182dbb73295a064 MD5 | raw file
- <!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>cf.AuxiliaryCoordinate.name — Documentation</title>
-
- <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
- <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../',
- VERSION: '1.1.10',
- 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/copybutton.js"></script>
- <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
- <link rel="top" title="Documentation" href="../index.html" />
- <link rel="up" title="cf.AuxiliaryCoordinate" href="../classes/cf.AuxiliaryCoordinate.html" />
- <link rel="next" title="cf.AuxiliaryCoordinate.override_units" href="cf.AuxiliaryCoordinate.override_units.html" />
- <link rel="prev" title="cf.AuxiliaryCoordinate.match" href="cf.AuxiliaryCoordinate.match.html" />
- </head>
- <body role="document">
- <div class="related" role="navigation" aria-label="related navigation">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="../genindex.html" title="General Index"
- accesskey="I">index</a></li>
- <li class="right" >
- <a href="cf.AuxiliaryCoordinate.override_units.html" title="cf.AuxiliaryCoordinate.override_units"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="cf.AuxiliaryCoordinate.match.html" title="cf.AuxiliaryCoordinate.match"
- accesskey="P">previous</a> |</li>
- <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.10</a> »</li>
- <!--
- <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> »</li>
- <li><select onchange="location = this.options[this.selectedIndex].value;">
- <option value="../../1.0/index.html">1.0
- <option value="../../0.9.9/index.html">0.9.9
- <option value="../../0.9.8.3/index.html">0.9.8.3
- <option value="../../archive.html">Archive
- </select>
- </li>
- -->
-
- <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> »</li>
- <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> »</li>
- <li class="nav-item nav-item-2"><a href="../class.html" >Classes of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> »</li>
- <li class="nav-item nav-item-3"><a href="../classes/cf.AuxiliaryCoordinate.html" accesskey="U">cf.AuxiliaryCoordinate</a> »</li>
- </ul>
- </div>
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <div class="section" id="cf-auxiliarycoordinate-name">
- <h1>cf.AuxiliaryCoordinate.name<a class="headerlink" href="#cf-auxiliarycoordinate-name" title="Permalink to this headline">Âś</a></h1>
- <dl class="method">
- <dt id="cf.AuxiliaryCoordinate.name">
- <code class="descclassname">AuxiliaryCoordinate.</code><code class="descname">name</code><span class="sig-paren">(</span><em>default=None</em>, <em>identity=False</em>, <em>ncvar=False</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1.10/cf/variable.py#variable.py-6396"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.AuxiliaryCoordinate.name" title="Permalink to this definition">Âś</a></dt>
- <dd><p>Return a name.</p>
- <p>By default the name is the first found of the following:</p>
- <blockquote>
- <div><ol class="arabic simple">
- <li>The <a class="reference internal" href="cf.AuxiliaryCoordinate.standard_name.html#cf.AuxiliaryCoordinate.standard_name" title="cf.AuxiliaryCoordinate.standard_name"><code class="xref py py-obj docutils literal"><span class="pre">standard_name</span></code></a> CF property.</li>
- <li>The <a class="reference internal" href="cf.AuxiliaryCoordinate.long_name.html#cf.AuxiliaryCoordinate.long_name" title="cf.AuxiliaryCoordinate.long_name"><code class="xref py py-obj docutils literal"><span class="pre">long_name</span></code></a> CF property, preceeded by the string
- <code class="docutils literal"><span class="pre">'long_name:'</span></code>.</li>
- <li>The <code class="xref py py-obj docutils literal"><span class="pre">id</span></code> attribute.</li>
- <li>The <code class="xref py py-obj docutils literal"><span class="pre">ncvar</span></code> attribute, preceeded by the string <code class="docutils literal"><span class="pre">'ncvar%'</span></code>.</li>
- <li>The value of the <em>default</em> parameter.</li>
- </ol>
- </div></blockquote>
- <p>Note that <code class="docutils literal"><span class="pre">f.name(identity=True)</span></code> is equivalent to <code class="docutils literal"><span class="pre">f.identity()</span></code>.</p>
- <div class="admonition seealso">
- <p class="first admonition-title">See also</p>
- <p class="last"><a class="reference internal" href="cf.AuxiliaryCoordinate.identity.html#cf.AuxiliaryCoordinate.identity" title="cf.AuxiliaryCoordinate.identity"><code class="xref py py-obj docutils literal"><span class="pre">identity</span></code></a></p>
- </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">Examples 1:</th><td class="field-body"></td>
- </tr>
- </tbody>
- </table>
- <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">n</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">()</span>
- <span class="gp">>>> </span><span class="n">n</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s1">'NO 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"><dl class="first docutils">
- <dt>default <span class="classifier-delimiter">:</span> <span class="classifier"><em>optional</em></span></dt>
- <dd><p class="first last">If no name can be found then return the value of the <em>default</em>
- parameter. By default the default is <a class="reference external" href="http://docs.python.org/2.7/library/constants.html#None" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">None</span></code></a>.</p>
- </dd>
- <dt>identity <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
- <dd><p class="first last">If True then only 1., 3. and 5. are considered as possible
- names.</p>
- </dd>
- <dt>ncvar <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
- <dd><p class="first last">If True then only 4. and 5. are considered as possible names.</p>
- </dd>
- </dl>
- </td>
- </tr>
- <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
- <dt>out :</dt>
- <dd><p class="first last">The name.</p>
- </dd>
- </dl>
- </td>
- </tr>
- <tr class="field-odd field"><th class="field-name">Examples 2:</th><td class="field-body"></td>
- </tr>
- </tbody>
- </table>
- <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">standard_name</span> <span class="o">=</span> <span class="s1">'air_temperature'</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">long_name</span> <span class="o">=</span> <span class="s1">'temperature of the air'</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">ncvar</span> <span class="o">=</span> <span class="s1">'tas'</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">()</span>
- <span class="go">'air_temperature'</span>
- <span class="gp">>>> </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">standard_name</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">()</span>
- <span class="go">'long_name:temperature of the air'</span>
- <span class="gp">>>> </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">long_name</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">()</span>
- <span class="go">'ncvar:tas'</span>
- <span class="gp">>>> </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">ncvar</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">()</span>
- <span class="go">None</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">(</span><span class="s1">'no_name'</span><span class="p">)</span>
- <span class="go">'no_name'</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">standard_name</span> <span class="o">=</span> <span class="s1">'air_temperature'</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">name</span><span class="p">(</span><span class="s1">'no_name'</span><span class="p">)</span>
- <span class="go">'air_temperature'</span>
- </pre></div>
- </div>
- </dd></dl>
- </div>
- </div>
- </div>
- </div>
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
- <div class="sphinxsidebarwrapper">
- <h4>Previous topic</h4>
- <p class="topless"><a href="cf.AuxiliaryCoordinate.match.html"
- title="previous chapter">cf.AuxiliaryCoordinate.match</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="cf.AuxiliaryCoordinate.override_units.html"
- title="next chapter">cf.AuxiliaryCoordinate.override_units</a></p>
- <div role="note" aria-label="source link">
- <h3>This Page</h3>
- <ul class="this-page-menu">
- <li><a href="../_sources/generated/cf.AuxiliaryCoordinate.name.txt"
- rel="nofollow">Show Source</a></li>
- </ul>
- </div>
- <div id="searchbox" style="display: none" role="search">
- <h3>Quick search</h3>
- <form class="search" action="../search.html" method="get">
- <input type="text" name="q" />
- <input type="submit" value="Go" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- <p class="searchtip" style="font-size: 90%">
- Enter search terms or a module, class or function name.
- </p>
- </div>
- <script type="text/javascript">$('#searchbox').show(0);</script>
- </div>
- </div>
- <div class="clearer"></div>
- </div>
- <div class="related" role="navigation" aria-label="related navigation">
- <h3>Navigation</h3>
- <ul>
- <li class="right" style="margin-right: 10px">
- <a href="../genindex.html" title="General Index"
- >index</a></li>
- <li class="right" >
- <a href="cf.AuxiliaryCoordinate.override_units.html" title="cf.AuxiliaryCoordinate.override_units"
- >next</a> |</li>
- <li class="right" >
- <a href="cf.AuxiliaryCoordinate.match.html" title="cf.AuxiliaryCoordinate.match"
- >previous</a> |</li>
- <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.10</a> »</li>
- <!--
- <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> »</li>
- <li><select onchange="location = this.options[this.selectedIndex].value;">
- <option value="../../1.0/index.html">1.0
- <option value="../../0.9.9/index.html">0.9.9
- <option value="../../0.9.8.3/index.html">0.9.8.3
- <option value="../../archive.html">Archive
- </select>
- </li>
- -->
-
- <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> »</li>
- <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> »</li>
- <li class="nav-item nav-item-2"><a href="../class.html" >Classes of the <code class="docutils literal"><span class="pre">cf</span></code> module</a> »</li>
- <li class="nav-item nav-item-3"><a href="../classes/cf.AuxiliaryCoordinate.html" >cf.AuxiliaryCoordinate</a> »</li>
- </ul>
- </div>
- <div class="footer" role="contentinfo">
- © Copyright 2016, David Hassell.
- Last updated on Jun 23, 2016.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
- </div>
- </body>
- </html>