PageRenderTime 30ms CodeModel.GetById 0ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/2.0/generated/cf.FieldList.fill_value.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 223 lines | 179 code | 14 blank | 30 comment | 0 complexity | 0e8615df271cf69041413ab51181ce55 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>cf.FieldList.fill_value &#8212; Documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    '../',
    17. 

  17.         VERSION:     '2.0',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true,
    21. 

  21.         SOURCELINK_SUFFIX: '.txt'
    22. 

  22.       };
    23. 

  23.     </script>
    24. 

  24.     <script type="text/javascript" src="../_static/jquery.js"></script>
    25. 

  25.     <script type="text/javascript" src="../_static/underscore.js"></script>
    26. 

  26.     <script type="text/javascript" src="../_static/doctools.js"></script>
    27. 

  27.     <script type="text/javascript" src="../_static/copybutton.js"></script>
    28. 

  28.     <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    29. 

  29.     <link rel="index" title="Index" href="../genindex.html" />
    30. 

  30.     <link rel="search" title="Search" href="../search.html" />
    31. 

  31.     <link rel="next" title="cf.FieldList.identity" href="cf.FieldList.identity.html" />
    32. 

  32.     <link rel="prev" title="cf.FieldList.dump" href="cf.FieldList.dump.html" /> 
    33. 

  33.   </head>
    34. 

  34.   <body role="document">
    35. 

  35.     <div class="related" role="navigation" aria-label="related navigation">
    36. 

  36.       <h3>Navigation</h3>
    37. 

  37.       <ul>
    38. 

  38.         <li class="right" style="margin-right: 10px">
    39. 

  39.           <a href="../genindex.html" title="General Index"
    40. 

  40.              accesskey="I">index</a></li>
    41. 

  41.         <li class="right" >
    42. 

  42.           <a href="cf.FieldList.identity.html" title="cf.FieldList.identity"
    43. 

  43.              accesskey="N">next</a> |</li>
    44. 

  44.         <li class="right" >
    45. 

  45.           <a href="cf.FieldList.dump.html" title="cf.FieldList.dump"
    46. 

  46.              accesskey="P">previous</a> |</li>
    47. 

  47.   <li><a target="_blank" href="../../archive.html">Archive</a> &laquo;</li>
    48. 

  48.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> &raquo;</li>
    49. 

  49. <!--
    50. 

  50.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python</a> &raquo;</li>
    51. 

  51.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    52. 

  52. 

  53.       <option value="../../1.0/index.html">1.0
    54. 

  54. 

  55.       <option value="../../0.9.9/index.html">0.9.9
    56. 

  56. 

  57.       <option value="../../0.9.8.3/index.html">0.9.8.3
    58. 

  58. 

  59.       <option value="../../archive.html">Archive
    60. 

  60. 

  61.       </select>
    62. 

  62.   </li>
    63. 

  63. -->
    64. 

  64.   
    65. 

  65.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &#187;</li>
    66. 

  66. 

  67.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &#187;</li>
    68. 

  68.           <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> &#187;</li>
    69. 

  69.           <li class="nav-item nav-item-3"><a href="../classes/cf.FieldList.html" accesskey="U">cf.FieldList</a> &#187;</li> 
    70. 

  70.       </ul>
    71. 

  71.     </div>  
    72. 

  72. 

  73.     <div class="document">
    74. 

  74.       <div class="documentwrapper">
    75. 

  75.         <div class="bodywrapper">
    76. 

  76.           <div class="body" role="main">
    77. 

  77.             
    78. 

  78.   <div class="section" id="cf-fieldlist-fill-value">
    79. 

  79. <h1>cf.FieldList.fill_value<a class="headerlink" href="#cf-fieldlist-fill-value" title="Permalink to this headline">Âś</a></h1>
    80. 

  80. <dl class="method">
    81. 

  81. <dt id="cf.FieldList.fill_value">
    82. 

  82. <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>
    83. 

  83. <dd><p>Return the data array missing data value.</p>
    84. 

  84. <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
    85. 

  85. 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
    86. 

  86. 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
    87. 

  87. value for the array&#8217;s data type is assumed if a missing data value is
    88. 

  88. required.</p>
    89. 

  89. <table class="docutils field-list" frame="void" rules="none">
    90. 

  90. <col class="field-name" />
    91. 

  91. <col class="field-body" />
    92. 

  92. <tbody valign="top">
    93. 

  93. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
    94. 

  94. <dt>default</dt>
    95. 

  95.  <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
    96. 

  96. 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
    97. 

  97. value <code class="docutils literal"><span class="pre">'netCDF'</span></code> then return the netCDF default value
    98. 

  98. appropriate to the data array&#8217;s data type is used. These may
    99. 

  99. be found as follows:</p>
    100. 

  100. <div class="last highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">netCDF4</span>
    101. 

  101. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">netCDF4</span><span class="o">.</span><span class="n">default_fillvals</span>    
    102. 

  102. </pre></div>
    103. 

  103. </div>
    104. 

  104. </dd>
    105. 

  105. </dl>
    106. 

  106. </td>
    107. 

  107. </tr>
    108. 

  108. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
    109. 

  109. <dt>out :</dt>
    110. 

  110. <dd><p class="first last">The missing data value, or the value specified by <em>default</em> if
    111. 

  111. one has not been set.</p>
    112. 

  112. </dd>
    113. 

  113. </dl>
    114. 

  114. </td>
    115. 

  115. </tr>
    116. 

  116. <tr class="field-odd field"><th class="field-name">Examples:</th><td class="field-body"></td>
    117. 

  117. </tr>
    118. 

  118. </tbody>
    119. 

  119. </table>
    120. 

  120. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
    121. 

  121. <span class="go">None</span>
    122. 

  122. <span class="gp">&gt;&gt;&gt; </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>
    123. 

  123. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
    124. 

  124. <span class="go">-1e30</span>
    125. 

  125. <span class="gp">&gt;&gt;&gt; </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>
    126. 

  126. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
    127. 

  127. <span class="go">1073741824</span>
    128. 

  128. <span class="gp">&gt;&gt;&gt; </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">missing_value</span>
    129. 

  129. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
    130. 

  130. <span class="go">-1e30</span>
    131. 

  131. <span class="gp">&gt;&gt;&gt; </span><span class="k">del</span> <span class="n">f</span><span class="o">.</span><span class="n">_FillValue</span>
    132. 

  132. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">()</span>
    133. 

  133. <span class="go">None</span>
    134. 

  134. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="p">,</span><span class="n">dtype</span>
    135. 

  135. <span class="go">dtype(&#39;float64&#39;)</span>
    136. 

  136. <span class="gp">&gt;&gt;&gt; </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">&#39;netCDF&#39;</span><span class="p">)</span>
    137. 

  137. <span class="go">9.969209968386869e+36</span>
    138. 

  138. <span class="gp">&gt;&gt;&gt; </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>
    139. 

  139. <span class="gp">&gt;&gt;&gt; </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">&#39;netCDF&#39;</span><span class="p">)</span>
    140. 

  140. <span class="go">-999</span>
    141. 

  141. </pre></div>
    142. 

  142. </div>
    143. 

  143. </dd></dl>
    144. 

  144. 

  145. </div>
    146. 

  146. 

  147. 

  148.           </div>
    149. 

  149.         </div>
    150. 

  150.       </div>
    151. 

  151.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    152. 

  152.         <div class="sphinxsidebarwrapper">
    153. 

  153.   <h4>Previous topic</h4>
    154. 

  154.   <p class="topless"><a href="cf.FieldList.dump.html"
    155. 

  155.                         title="previous chapter">cf.FieldList.dump</a></p>
    156. 

  156.   <h4>Next topic</h4>
    157. 

  157.   <p class="topless"><a href="cf.FieldList.identity.html"
    158. 

  158.                         title="next chapter">cf.FieldList.identity</a></p>
    159. 

  159.   <div role="note" aria-label="source link">
    160. 

  160.     <h3>This Page</h3>
    161. 

  161.     <ul class="this-page-menu">
    162. 

  162.       <li><a href="../_sources/generated/cf.FieldList.fill_value.rst.txt"
    163. 

  163.             rel="nofollow">Show Source</a></li>
    164. 

  164.     </ul>
    165. 

  165.    </div>
    166. 

  166. <div id="searchbox" style="display: none" role="search">
    167. 

  167.   <h3>Quick search</h3>
    168. 

  168.     <form class="search" action="../search.html" method="get">
    169. 

  169.       <div><input type="text" name="q" /></div>
    170. 

  170.       <div><input type="submit" value="Go" /></div>
    171. 

  171.       <input type="hidden" name="check_keywords" value="yes" />
    172. 

  172.       <input type="hidden" name="area" value="default" />
    173. 

  173.     </form>
    174. 

  174. </div>
    175. 

  175. <script type="text/javascript">$('#searchbox').show(0);</script>
    176. 

  176.         </div>
    177. 

  177.       </div>
    178. 

  178.       <div class="clearer"></div>
    179. 

  179.     </div>
    180. 

  180.     <div class="related" role="navigation" aria-label="related navigation">
    181. 

  181.       <h3>Navigation</h3>
    182. 

  182.       <ul>
    183. 

  183.         <li class="right" style="margin-right: 10px">
    184. 

  184.           <a href="../genindex.html" title="General Index"
    185. 

  185.              >index</a></li>
    186. 

  186.         <li class="right" >
    187. 

  187.           <a href="cf.FieldList.identity.html" title="cf.FieldList.identity"
    188. 

  188.              >next</a> |</li>
    189. 

  189.         <li class="right" >
    190. 

  190.           <a href="cf.FieldList.dump.html" title="cf.FieldList.dump"
    191. 

  191.              >previous</a> |</li>
    192. 

  192.   <li><a target="_blank" href="../../archive.html">Archive</a> &laquo;</li>
    193. 

  193.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python 2.0</a> &raquo;</li>
    194. 

  194. <!--
    195. 

  195.   <li><a target="_blank" href="http://cfpython.bitbucket.io">cf-python</a> &raquo;</li>
    196. 

  196.   <li><select onchange="location = this.options[this.selectedIndex].value;">
    197. 

  197. 

  198.       <option value="../../1.0/index.html">1.0
    199. 

  199. 

  200.       <option value="../../0.9.9/index.html">0.9.9
    201. 

  201. 

  202.       <option value="../../0.9.8.3/index.html">0.9.8.3
    203. 

  203. 

  204.       <option value="../../archive.html">Archive
    205. 

  205. 

  206.       </select>
    207. 

  207.   </li>
    208. 

  208. -->
    209. 

  209.   
    210. 

  210.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &#187;</li>
    211. 

  211. 

  212.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &#187;</li>
    213. 

  213.           <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> &#187;</li>
    214. 

  214.           <li class="nav-item nav-item-3"><a href="../classes/cf.FieldList.html" >cf.FieldList</a> &#187;</li> 
    215. 

  215.       </ul>
    216. 

  216.     </div>
    217. 

  217.     <div class="footer" role="contentinfo">
    218. 

  218.         &#169; Copyright 2016, David Hassell.
    219. 

  219.       Last updated on Jul 07, 2017.
    220. 

  220.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
    221. 

  221.     </div>
    222. 

  222.   </body>
    223. 

  223. </html>
    224.