/docs/2.0/generated/cf.FieldList.fill_value.html
HTML | 223 lines | 179 code | 14 blank | 30 comment | 0 complexity | 0e8615df271cf69041413ab51181ce55 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.FieldList.fill_value — 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: '2.0',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true,
- SOURCELINK_SUFFIX: '.txt'
- };
- </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="index" title="Index" href="../genindex.html" />
- <link rel="search" title="Search" href="../search.html" />
- <link rel="next" title="cf.FieldList.identity" href="cf.FieldList.identity.html" />
- <link rel="prev" title="cf.FieldList.dump" href="cf.FieldList.dump.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.FieldList.identity.html" title="cf.FieldList.identity"
- accesskey="N">next</a> |</li>
- <li class="right" >
- <a href="cf.FieldList.dump.html" title="cf.FieldList.dump"
- accesskey="P">previous</a> |</li>
- <li><a target="_blank" href="../../archive.html">Archive</a> «</li>
- <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> »</li>
- <!--
- <li><a target="_blank" href="http://cfpython.bitbucket.io">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.FieldList.html" accesskey="U">cf.FieldList</a> »</li>
- </ul>
- </div>
- <div class="document">
- <div class="documentwrapper">
- <div class="bodywrapper">
- <div class="body" role="main">
-
- <div class="section" id="cf-fieldlist-fill-value">
- <h1>cf.FieldList.fill_value<a class="headerlink" href="#cf-fieldlist-fill-value" title="Permalink to this headline">Âś</a></h1>
- <dl class="method">
- <dt id="cf.FieldList.fill_value">
- <code class="descclassname">FieldList.</code><code class="descname">fill_value</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v2.0/cf/variable.py#variable.py-5565"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.FieldList.fill_value" title="Permalink to this definition">Âś</a></dt>
- <dd><p>Return the data array missing data value.</p>
- <p>This is the value of the <code class="xref py py-obj docutils literal"><span class="pre">missing_value</span></code> CF property, or if that is
- not set, the value of the <code class="xref py py-obj docutils literal"><span class="pre">_FillValue</span></code> CF property, else if that is
- not set, <code class="docutils literal"><span class="pre">None</span></code>. In the last case the default <a class="reference external" href="https://docs.scipy.org/doc/numpy/reference/index.html#module-numpy" title="(in NumPy v1.13)"><code class="xref py py-obj docutils literal"><span class="pre">numpy</span></code></a> missing data
- value for the array’s data type is assumed if a missing data value is
- required.</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"><dl class="first docutils">
- <dt>default</dt>
- <span class="classifier-delimiter">:</span> <span class="classifier"><em>optional</em></span><dd><p class="first">If the missing value is unset then return this value. By
- default, <em>default</em> is <a class="reference external" href="https://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>. If <em>default</em> is the special
- value <code class="docutils literal"><span class="pre">'netCDF'</span></code> then return the netCDF default value
- appropriate to the data array’s data type is used. These may
- be found as follows:</p>
- <div class="last highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">netCDF4</span>
- <span class="gp">>>> </span><span class="k">print</span> <span class="n">netCDF4</span><span class="o">.</span><span class="n">default_fillvals</span>
- </pre></div>
- </div>
- </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 missing data value, or the value specified by <em>default</em> if
- one has not been set.</p>
- </dd>
- </dl>
- </td>
- </tr>
- <tr class="field-odd field"><th class="field-name">Examples:</th><td class="field-body"></td>
- </tr>
- </tbody>
- </table>
- <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</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">_FillValue</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1e30</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
- <span class="go">-1e30</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">missing_value</span> <span class="o">=</span> <span class="mi">1073741824</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
- <span class="go">1073741824</span>
- <span class="gp">>>> </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">missing_value</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
- <span class="go">-1e30</span>
- <span class="gp">>>> </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">_FillValue</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
- <span class="go">None</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="p">,</span><span class="n">dtype</span>
- <span class="go">dtype('float64')</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s1">'netCDF'</span><span class="p">)</span>
- <span class="go">9.969209968386869e+36</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">_FillValue</span> <span class="o">=</span> <span class="o">-</span><span class="mi">999</span>
- <span class="gp">>>> </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="s1">'netCDF'</span><span class="p">)</span>
- <span class="go">-999</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.FieldList.dump.html"
- title="previous chapter">cf.FieldList.dump</a></p>
- <h4>Next topic</h4>
- <p class="topless"><a href="cf.FieldList.identity.html"
- title="next chapter">cf.FieldList.identity</a></p>
- <div role="note" aria-label="source link">
- <h3>This Page</h3>
- <ul class="this-page-menu">
- <li><a href="../_sources/generated/cf.FieldList.fill_value.rst.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">
- <div><input type="text" name="q" /></div>
- <div><input type="submit" value="Go" /></div>
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </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.FieldList.identity.html" title="cf.FieldList.identity"
- >next</a> |</li>
- <li class="right" >
- <a href="cf.FieldList.dump.html" title="cf.FieldList.dump"
- >previous</a> |</li>
- <li><a target="_blank" href="../../archive.html">Archive</a> «</li>
- <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> »</li>
- <!--
- <li><a target="_blank" href="http://cfpython.bitbucket.io">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.FieldList.html" >cf.FieldList</a> »</li>
- </ul>
- </div>
- <div class="footer" role="contentinfo">
- © Copyright 2016, David Hassell.
- Last updated on Jul 07, 2017.
- Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
- </div>
- </body>
- </html>