PageRenderTime 45ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.2.3/generated/cf.Field.missing_value.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 190 lines | 146 code | 14 blank | 30 comment | 0 complexity | 6d8bcd61bfcb2354d1710bdd147c2944 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.Field.missing_value &mdash; 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:     '1.2.3',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

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

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

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

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

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

  28.     <link rel="top" title="Documentation" href="../index.html" />
    29. 

  29.     <link rel="up" title="cf.Field" href="../classes/cf.Field.html" />
    30. 

  30.     <link rel="next" title="cf.Field.month_lengths" href="cf.Field.month_lengths.html" />
    31. 

  31.     <link rel="prev" title="cf.Field.long_name" href="cf.Field.long_name.html" /> 
    32. 

  32.   </head>
    33. 

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

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

  35.       <h3>Navigation</h3>
    36. 

  36.       <ul>
    37. 

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

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

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

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

  41.           <a href="cf.Field.month_lengths.html" title="cf.Field.month_lengths"
    42. 

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

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

  44.           <a href="cf.Field.long_name.html" title="cf.Field.long_name"
    45. 

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

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

  47.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.2.3</a> &raquo;</li>
    48. 

  48. <!--
    49. 

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

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

  51. 

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

  53. 

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

  55. 

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

  57. 

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

  59. 

  60.       </select>
    61. 

  61.   </li>
    62. 

  62. -->
    63. 

  63.   
    64. 

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

  65. 

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

  67.           <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> &raquo;</li>
    68. 

  68.           <li class="nav-item nav-item-3"><a href="../classes/cf.Field.html" accesskey="U">cf.Field</a> &raquo;</li> 
    69. 

  69.       </ul>
    70. 

  70.     </div>  
    71. 

  71. 

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

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

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

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

  76.             
    77. 

  77.   <div class="section" id="cf-field-missing-value">
    78. 

  78. <h1>cf.Field.missing_value<a class="headerlink" href="#cf-field-missing-value" title="Permalink to this headline">Âś</a></h1>
    79. 

  79. <dl class="attribute">
    80. 

  80. <dt id="cf.Field.missing_value">
    81. 

  81. <code class="descclassname">Field.</code><code class="descname">missing_value</code><a class="headerlink" href="#cf.Field.missing_value" title="Permalink to this definition">Âś</a></dt>
    82. 

  82. <dd><p>The missing_value CF property.</p>
    83. 

  83. <p>Note that this attribute is used primarily for writing data to disk
    84. 

  84. and is independent of the missing data mask. It may, however, be used
    85. 

  85. when unmasking data array elements.</p>
    86. 

  86. <p>The recommended way of retrieving the missing data value is with the
    87. 

  87. <a class="reference internal" href="cf.Field.fill_value.html#cf.Field.fill_value" title="cf.Field.fill_value"><code class="xref py py-obj docutils literal"><span class="pre">fill_value</span></code></a> method.</p>
    88. 

  88. <div class="admonition seealso">
    89. 

  89. <p class="first admonition-title">See also</p>
    90. 

  90. <p class="last"><a class="reference internal" href="cf.Field._FillValue.html#cf.Field._FillValue" title="cf.Field._FillValue"><code class="xref py py-obj docutils literal"><span class="pre">_FillValue</span></code></a>, <a class="reference internal" href="cf.Field.fill_value.html#cf.Field.fill_value" title="cf.Field.fill_value"><code class="xref py py-obj docutils literal"><span class="pre">fill_value</span></code></a></p>
    91. 

  91. </div>
    92. 

  92. <table class="docutils field-list" frame="void" rules="none">
    93. 

  93. <col class="field-name" />
    94. 

  94. <col class="field-body" />
    95. 

  95. <tbody valign="top">
    96. 

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

  97. </tr>
    98. 

  98. </tbody>
    99. 

  99. </table>
    100. 

  100. <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">missing_value</span> <span class="o">=</span> <span class="mf">1.0e30</span>
    101. 

  101. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">missing_value</span>
    102. 

  102. <span class="go">1e+30</span>
    103. 

  103. <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>
    104. 

  104. </pre></div>
    105. 

  105. </div>
    106. 

  106. <p>Mask the data array where it equals a missing data value:</p>
    107. 

  107. <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">setitem</span><span class="p">(</span><span class="n">cf</span><span class="o">.</span><span class="n">masked</span><span class="p">,</span> <span class="n">condition</span><span class="o">=</span><span class="n">f</span><span class="o">.</span><span class="n">fill_value</span><span class="p">())</span> <span class="n">DCH</span>
    108. 

  108. </pre></div>
    109. 

  109. </div>
    110. 

  110. </dd></dl>
    111. 

  111. 

  112. </div>
    113. 

  113. 

  114. 

  115.           </div>
    116. 

  116.         </div>
    117. 

  117.       </div>
    118. 

  118.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    119. 

  119.         <div class="sphinxsidebarwrapper">
    120. 

  120.   <h4>Previous topic</h4>
    121. 

  121.   <p class="topless"><a href="cf.Field.long_name.html"
    122. 

  122.                         title="previous chapter">cf.Field.long_name</a></p>
    123. 

  123.   <h4>Next topic</h4>
    124. 

  124.   <p class="topless"><a href="cf.Field.month_lengths.html"
    125. 

  125.                         title="next chapter">cf.Field.month_lengths</a></p>
    126. 

  126.   <div role="note" aria-label="source link">
    127. 

  127.     <h3>This Page</h3>
    128. 

  128.     <ul class="this-page-menu">
    129. 

  129.       <li><a href="../_sources/generated/cf.Field.missing_value.txt"
    130. 

  130.             rel="nofollow">Show Source</a></li>
    131. 

  131.     </ul>
    132. 

  132.    </div>
    133. 

  133. <div id="searchbox" style="display: none" role="search">
    134. 

  134.   <h3>Quick search</h3>
    135. 

  135.     <form class="search" action="../search.html" method="get">
    136. 

  136.       <input type="text" name="q" />
    137. 

  137.       <input type="submit" value="Go" />
    138. 

  138.       <input type="hidden" name="check_keywords" value="yes" />
    139. 

  139.       <input type="hidden" name="area" value="default" />
    140. 

  140.     </form>
    141. 

  141. </div>
    142. 

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

  143.         </div>
    144. 

  144.       </div>
    145. 

  145.       <div class="clearer"></div>
    146. 

  146.     </div>
    147. 

  147.     <div class="related" role="navigation" aria-label="related navigation">
    148. 

  148.       <h3>Navigation</h3>
    149. 

  149.       <ul>
    150. 

  150.         <li class="right" style="margin-right: 10px">
    151. 

  151.           <a href="../genindex.html" title="General Index"
    152. 

  152.              >index</a></li>
    153. 

  153.         <li class="right" >
    154. 

  154.           <a href="cf.Field.month_lengths.html" title="cf.Field.month_lengths"
    155. 

  155.              >next</a> |</li>
    156. 

  156.         <li class="right" >
    157. 

  157.           <a href="cf.Field.long_name.html" title="cf.Field.long_name"
    158. 

  158.              >previous</a> |</li>
    159. 

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

  160.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.2.3</a> &raquo;</li>
    161. 

  161. <!--
    162. 

  162.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python</a> &raquo;</li>
    163. 

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

  164. 

  165.       <option value="../../1.0/index.html">1.0
    166. 

  166. 

  167.       <option value="../../0.9.9/index.html">0.9.9
    168. 

  168. 

  169.       <option value="../../0.9.8.3/index.html">0.9.8.3
    170. 

  170. 

  171.       <option value="../../archive.html">Archive
    172. 

  172. 

  173.       </select>
    174. 

  174.   </li>
    175. 

  175. -->
    176. 

  176.   
    177. 

  177.         <li class="nav-item nav-item-0"><a href="../index.html">Documentation</a> &raquo;</li>
    178. 

  178. 

  179.           <li class="nav-item nav-item-1"><a href="../reference.html" >Reference manual</a> &raquo;</li>
    180. 

  180.           <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> &raquo;</li>
    181. 

  181.           <li class="nav-item nav-item-3"><a href="../classes/cf.Field.html" >cf.Field</a> &raquo;</li> 
    182. 

  182.       </ul>
    183. 

  183.     </div>
    184. 

  184.     <div class="footer" role="contentinfo">
    185. 

  185.         &copy; Copyright 2016, David Hassell.
    186. 

  186.       Last updated on Aug 23, 2016.
    187. 

  187.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.1.
    188. 

  188.     </div>
    189. 

  189.   </body>
    190. 

  190. </html>
    191.