PageRenderTime 44ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.1.8/generated/cf.AuxiliaryCoordinate.mask_invalid.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 241 lines | 197 code | 14 blank | 30 comment | 0 complexity | f3c15073aa6d8916123f7b821dc9392b 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.AuxiliaryCoordinate.mask_invalid &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.1.8',
    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.AuxiliaryCoordinate" href="../classes/cf.AuxiliaryCoordinate.html" />
    30. 

  30.     <link rel="next" title="cf.AuxiliaryCoordinate.match" href="cf.AuxiliaryCoordinate.match.html" />
    31. 

  31.     <link rel="prev" title="cf.AuxiliaryCoordinate.insert_data" href="cf.AuxiliaryCoordinate.insert_data.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.AuxiliaryCoordinate.match.html" title="cf.AuxiliaryCoordinate.match"
    42. 

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

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

  44.           <a href="cf.AuxiliaryCoordinate.insert_data.html" title="cf.AuxiliaryCoordinate.insert_data"
    45. 

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

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

  47. <!--
    48. 

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

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

  50. 

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

  52. 

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

  54. 

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

  56. 

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

  58. 

  59.       </select>
    60. 

  60.   </li>
    61. 

  61. -->
    62. 

  62.   
    63. 

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

  64. 

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

  66.           <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>
    67. 

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

  68.       </ul>
    69. 

  69.     </div>  
    70. 

  70. 

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

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

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

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

  75.             
    76. 

  76.   <div class="section" id="cf-auxiliarycoordinate-mask-invalid">
    77. 

  77. <h1>cf.AuxiliaryCoordinate.mask_invalid<a class="headerlink" href="#cf-auxiliarycoordinate-mask-invalid" title="Permalink to this headline">Âś</a></h1>
    78. 

  78. <dl class="method">
    79. 

  79. <dt id="cf.AuxiliaryCoordinate.mask_invalid">
    80. 

  80. <code class="descclassname">AuxiliaryCoordinate.</code><code class="descname">mask_invalid</code><span class="sig-paren">(</span><em>i=False</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1.8/cf/variable.py#variable.py-2431"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.AuxiliaryCoordinate.mask_invalid" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>Mask the array where invalid values occur (NaN or inf).</p>
    82. 

  82. <p>Note that:</p>
    83. 

  83. <ul class="simple">
    84. 

  84. <li>Invalid values in the results of arithmetic operations only occur if
    85. 

  85. the raising of <code class="xref py py-obj docutils literal"><span class="pre">FloatingPointError</span></code> exceptions has been suppressed
    86. 

  86. by <a class="reference internal" href="cf.Data.seterr.html#cf.Data.seterr" title="cf.Data.seterr"><code class="xref py py-obj docutils literal"><span class="pre">cf.Data.seterr</span></code></a>.</li>
    87. 

  87. <li>If the raising of <code class="xref py py-obj docutils literal"><span class="pre">FloatingPointError</span></code> exceptions has been allowed
    88. 

  88. then invalid values in the results of arithmetic operations it is
    89. 

  89. possible for them to be automatically converted to masked values,
    90. 

  90. depending on the setting of <a class="reference internal" href="cf.Data.mask_fpe.html#cf.Data.mask_fpe" title="cf.Data.mask_fpe"><code class="xref py py-obj docutils literal"><span class="pre">cf.Data.mask_fpe</span></code></a>. In this case, such
    91. 

  91. automatic conversion might be faster than calling <a class="reference internal" href="#cf.AuxiliaryCoordinate.mask_invalid" title="cf.AuxiliaryCoordinate.mask_invalid"><code class="xref py py-obj docutils literal"><span class="pre">mask_invalid</span></code></a>.</li>
    92. 

  92. </ul>
    93. 

  93. <div class="admonition seealso">
    94. 

  94. <p class="first admonition-title">See also</p>
    95. 

  95. <p class="last"><a class="reference internal" href="cf.Data.mask_fpe.html#cf.Data.mask_fpe" title="cf.Data.mask_fpe"><code class="xref py py-obj docutils literal"><span class="pre">cf.Data.mask_fpe</span></code></a>, <a class="reference internal" href="cf.Data.seterr.html#cf.Data.seterr" title="cf.Data.seterr"><code class="xref py py-obj docutils literal"><span class="pre">cf.Data.seterr</span></code></a></p>
    96. 

  96. </div>
    97. 

  97. <table class="docutils field-list" frame="void" rules="none">
    98. 

  98. <col class="field-name" />
    99. 

  99. <col class="field-body" />
    100. 

  100. <tbody valign="top">
    101. 

  101. <tr class="field-odd field"><th class="field-name">Examples 1:</th><td class="field-body"></td>
    102. 

  102. </tr>
    103. 

  103. </tbody>
    104. 

  104. </table>
    105. 

  105. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">g</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">mask_invalid</span><span class="p">()</span>
    106. 

  106. </pre></div>
    107. 

  107. </div>
    108. 

  108. <table class="docutils field-list" frame="void" rules="none">
    109. 

  109. <col class="field-name" />
    110. 

  110. <col class="field-body" />
    111. 

  111. <tbody valign="top">
    112. 

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

  113. <dt>i <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
    114. 

  114. <dd><p class="first last">If True then update the auxiliary coordinate in place. By default a new
    115. 

  115. auxiliary coordinate is created. In either case, a auxiliary coordinate is
    116. 

  116. returned.</p>
    117. 

  117. </dd>
    118. 

  118. </dl>
    119. 

  119. </td>
    120. 

  120. </tr>
    121. 

  121. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">out : cf.AuxiliaryCoordinate</p>
    122. 

  122. </td>
    123. 

  123. </tr>
    124. 

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

  125. </tr>
    126. 

  126. </tbody>
    127. 

  127. </table>
    128. 

  128. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">f</span><span class="o">.</span><span class="n">array</span>
    129. 

  129. <span class="go">[ 0.  1.]</span>
    130. 

  130. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">g</span><span class="o">.</span><span class="n">array</span>
    131. 

  131. <span class="go">[ 1.  2.]</span>
    132. 

  132. </pre></div>
    133. 

  133. </div>
    134. 

  134. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">Data</span><span class="o">.</span><span class="n">seterr</span><span class="p">(</span><span class="s1">&#39;ignore&#39;</span><span class="p">)</span>
    135. 

  135. <span class="gp">&gt;&gt;&gt; </span><span class="n">h</span> <span class="o">=</span> <span class="n">g</span><span class="o">/</span><span class="n">f</span>
    136. 

  136. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">h</span><span class="o">.</span><span class="n">array</span>
    137. 

  137. <span class="go">[ inf   2.]</span>
    138. 

  138. <span class="gp">&gt;&gt;&gt; </span><span class="n">h</span><span class="o">.</span><span class="n">mask_invalid</span><span class="p">(</span><span class="n">i</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    139. 

  139. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span>  <span class="n">h</span><span class="o">.</span><span class="n">array</span>
    140. 

  140. <span class="go">[--  2.]</span>
    141. 

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

  142. </div>
    143. 

  143. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">h</span> <span class="o">=</span> <span class="n">g</span><span class="o">**</span><span class="mi">12345</span>
    144. 

  144. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">h</span><span class="o">.</span><span class="n">array</span>
    145. 

  145. <span class="go">[ 1.  inf]</span>
    146. 

  146. <span class="gp">&gt;&gt;&gt; </span><span class="n">h</span> <span class="o">=</span> <span class="n">h</span><span class="o">.</span><span class="n">mask_invalid</span><span class="p">()</span>
    147. 

  147. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">h</span><span class="o">.</span><span class="n">array</span>
    148. 

  148. <span class="go">[1.  --]</span>
    149. 

  149. </pre></div>
    150. 

  150. </div>
    151. 

  151. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">Data</span><span class="o">.</span><span class="n">seterr</span><span class="p">(</span><span class="s1">&#39;raise&#39;</span><span class="p">)</span>
    152. 

  152. <span class="gp">&gt;&gt;&gt; </span><span class="n">old</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">Data</span><span class="o">.</span><span class="n">mask_fpe</span><span class="p">(</span><span class="bp">True</span><span class="p">)</span>
    153. 

  153. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="p">(</span><span class="n">g</span><span class="o">/</span><span class="n">f</span><span class="p">)</span><span class="o">.</span><span class="n">array</span>
    154. 

  154. <span class="go">[ --  2]</span>
    155. 

  155. <span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="p">(</span><span class="n">g</span><span class="o">**</span><span class="mi">12345</span><span class="p">)</span><span class="o">.</span><span class="n">array</span>
    156. 

  156. <span class="go">[1.  -- ]</span>
    157. 

  157. </pre></div>
    158. 

  158. </div>
    159. 

  159. </dd></dl>
    160. 

  160. 

  161. </div>
    162. 

  162. 

  163. 

  164.           </div>
    165. 

  165.         </div>
    166. 

  166.       </div>
    167. 

  167.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    168. 

  168.         <div class="sphinxsidebarwrapper">
    169. 

  169.   <h4>Previous topic</h4>
    170. 

  170.   <p class="topless"><a href="cf.AuxiliaryCoordinate.insert_data.html"
    171. 

  171.                         title="previous chapter">cf.AuxiliaryCoordinate.insert_data</a></p>
    172. 

  172.   <h4>Next topic</h4>
    173. 

  173.   <p class="topless"><a href="cf.AuxiliaryCoordinate.match.html"
    174. 

  174.                         title="next chapter">cf.AuxiliaryCoordinate.match</a></p>
    175. 

  175.   <div role="note" aria-label="source link">
    176. 

  176.     <h3>This Page</h3>
    177. 

  177.     <ul class="this-page-menu">
    178. 

  178.       <li><a href="../_sources/generated/cf.AuxiliaryCoordinate.mask_invalid.txt"
    179. 

  179.             rel="nofollow">Show Source</a></li>
    180. 

  180.     </ul>
    181. 

  181.    </div>
    182. 

  182. <div id="searchbox" style="display: none" role="search">
    183. 

  183.   <h3>Quick search</h3>
    184. 

  184.     <form class="search" action="../search.html" method="get">
    185. 

  185.       <input type="text" name="q" />
    186. 

  186.       <input type="submit" value="Go" />
    187. 

  187.       <input type="hidden" name="check_keywords" value="yes" />
    188. 

  188.       <input type="hidden" name="area" value="default" />
    189. 

  189.     </form>
    190. 

  190.     <p class="searchtip" style="font-size: 90%">
    191. 

  191.     Enter search terms or a module, class or function name.
    192. 

  192.     </p>
    193. 

  193. </div>
    194. 

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

  195.         </div>
    196. 

  196.       </div>
    197. 

  197.       <div class="clearer"></div>
    198. 

  198.     </div>
    199. 

  199.     <div class="related" role="navigation" aria-label="related navigation">
    200. 

  200.       <h3>Navigation</h3>
    201. 

  201.       <ul>
    202. 

  202.         <li class="right" style="margin-right: 10px">
    203. 

  203.           <a href="../genindex.html" title="General Index"
    204. 

  204.              >index</a></li>
    205. 

  205.         <li class="right" >
    206. 

  206.           <a href="cf.AuxiliaryCoordinate.match.html" title="cf.AuxiliaryCoordinate.match"
    207. 

  207.              >next</a> |</li>
    208. 

  208.         <li class="right" >
    209. 

  209.           <a href="cf.AuxiliaryCoordinate.insert_data.html" title="cf.AuxiliaryCoordinate.insert_data"
    210. 

  210.              >previous</a> |</li>
    211. 

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

  212. <!--
    213. 

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

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

  215. 

  216.       <option value="../../1.0/index.html">1.0
    217. 

  217. 

  218.       <option value="../../0.9.9/index.html">0.9.9
    219. 

  219. 

  220.       <option value="../../0.9.8.3/index.html">0.9.8.3
    221. 

  221. 

  222.       <option value="../../archive.html">Archive
    223. 

  223. 

  224.       </select>
    225. 

  225.   </li>
    226. 

  226. -->
    227. 

  227.   
    228. 

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

  229. 

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

  231.           <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>
    232. 

  232.           <li class="nav-item nav-item-3"><a href="../classes/cf.AuxiliaryCoordinate.html" >cf.AuxiliaryCoordinate</a> &raquo;</li> 
    233. 

  233.       </ul>
    234. 

  234.     </div>
    235. 

  235.     <div class="footer" role="contentinfo">
    236. 

  236.         &copy; Copyright 2016, David Hassell.
    237. 

  237.       Last updated on May 18, 2016.
    238. 

  238.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
    239. 

  239.     </div>
    240. 

  240.   </body>
    241. 

  241. </html>
    242.