PageRenderTime 40ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

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

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 287 lines | 243 code | 14 blank | 30 comment | 0 complexity | f4d711cc7f666130a1e8d8aaf9f29d39 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.remove_axes &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.remove_axis" href="cf.Field.remove_axis.html" />
    31. 

  31.     <link rel="prev" title="cf.Field.period" href="cf.Field.period.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.remove_axis.html" title="cf.Field.remove_axis"
    42. 

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

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

  44.           <a href="cf.Field.period.html" title="cf.Field.period"
    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-remove-axes">
    78. 

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

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

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

  81. <code class="descclassname">Field.</code><code class="descname">remove_axes</code><span class="sig-paren">(</span><em>axes=None</em>, <em>size=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.2.3/cf/field.py#field.py-10332"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.remove_axes" title="Permalink to this definition">Âś</a></dt>
    82. 

  82. <dd><p>Remove and return axes from the field.</p>
    83. 

  83. <p>By default all axes of the domain are removed, but particular axes may
    84. 

  84. be selected with the keyword arguments.</p>
    85. 

  85. <p>The axis may be selected with the keyword arguments. If no unique axis
    86. 

  86. can be found then no axis is removed and <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> is returned.</p>
    87. 

  87. <p>If an axis has size greater than 1 then it is not possible to remove
    88. 

  88. it if it is spanned by the field&#8217;s data array or any multidimensional
    89. 

  89. coordinate or cell measure object of the field.</p>
    90. 

  90. <div class="admonition seealso">
    91. 

  91. <p class="first admonition-title">See also</p>
    92. 

  92. <p class="last"><a class="reference internal" href="cf.Field.axes.html#cf.Field.axes" title="cf.Field.axes"><code class="xref py py-obj docutils literal"><span class="pre">axes</span></code></a>, <a class="reference internal" href="cf.Field.remove_axis.html#cf.Field.remove_axis" title="cf.Field.remove_axis"><code class="xref py py-obj docutils literal"><span class="pre">remove_axis</span></code></a>, <a class="reference internal" href="cf.Field.remove_item.html#cf.Field.remove_item" title="cf.Field.remove_item"><code class="xref py py-obj docutils literal"><span class="pre">remove_item</span></code></a>, <a class="reference internal" href="cf.Field.remove_items.html#cf.Field.remove_items" title="cf.Field.remove_items"><code class="xref py py-obj docutils literal"><span class="pre">remove_items</span></code></a></p>
    93. 

  93. </div>
    94. 

  94. <table class="docutils field-list" frame="void" rules="none">
    95. 

  95. <col class="field-name" />
    96. 

  96. <col class="field-body" />
    97. 

  97. <tbody valign="top">
    98. 

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

  99. <dt>axes, kwargs: optional</dt>
    100. 

  100. <dd><p class="first">Select axes. The <em>axes</em> parameter may be one, or a sequence,
    101. 

  101. of:</p>
    102. 

  102. <blockquote>
    103. 

  103. <div><ul class="simple">
    104. 

  104. <li><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>. If no <em>kwargs</em> arguments have been set
    105. 

  105. then all axes are selected. This is the default.</li>
    106. 

  106. </ul>
    107. 

  107. </div></blockquote>
    108. 

  108. <blockquote>
    109. 

  109. <div><ul>
    110. 

  110. <li><p class="first">An integer. Explicitly selects the axis corresponding to
    111. 

  111. the given position in the list of axes of the field&#8217;s data
    112. 

  112. array.</p>
    113. 

  113. <blockquote>
    114. 

  114. <div><dl class="docutils">
    115. 

  115. <dt><em>Example:</em></dt>
    116. 

  116. <dd><p class="first last">To select the third data array axis: <code class="docutils literal"><span class="pre">axes=2</span></code>. To
    117. 

  117. select the last axis: <code class="docutils literal"><span class="pre">axes=-1</span></code>.</p>
    118. 

  118. </dd>
    119. 

  119. </dl>
    120. 

  120. </div></blockquote>
    121. 

  121. </li>
    122. 

  122. </ul>
    123. 

  123. </div></blockquote>
    124. 

  124. <blockquote>
    125. 

  125. <div><ul>
    126. 

  126. <li><p class="first">A <a class="reference external" href="http://docs.python.org/2.7/library/functions.html#slice" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">slice</span></code></a> object. Explicitly selects the axes
    127. 

  127. corresponding to the given positions in the list of axes
    128. 

  128. of the field&#8217;s data array.</p>
    129. 

  129. <blockquote>
    130. 

  130. <div><dl class="docutils">
    131. 

  131. <dt><em>Example:</em> </dt>
    132. 

  132. <dd><p class="first last">To select the last three data array axes:
    133. 

  133. <code class="docutils literal"><span class="pre">axes=slice(-3,</span> <span class="pre">None)</span></code></p>
    134. 

  134. </dd>
    135. 

  135. </dl>
    136. 

  136. </div></blockquote>
    137. 

  137. </li>
    138. 

  138. </ul>
    139. 

  139. </div></blockquote>
    140. 

  140. <blockquote>
    141. 

  141. <div><ul>
    142. 

  142. <li><p class="first">A domain axis identifier. Explicitly selects this axis.</p>
    143. 

  143. <blockquote>
    144. 

  144. <div><dl class="docutils">
    145. 

  145. <dt><em>Example:</em></dt>
    146. 

  146. <dd><p class="first last">To select axis &#8220;dim1&#8221;: <code class="docutils literal"><span class="pre">axes='dim1'</span></code>.</p>
    147. 

  147. </dd>
    148. 

  148. </dl>
    149. 

  149. </div></blockquote>
    150. 

  150. </li>
    151. 

  151. </ul>
    152. 

  152. </div></blockquote>
    153. 

  153. <blockquote>
    154. 

  154. <div><ul>
    155. 

  155. <li><p class="first">Any value accepted by the <em>items</em> parameter of the field&#8217;s
    156. 

  156. <a class="reference internal" href="cf.Field.items.html#cf.Field.items" title="cf.Field.items"><code class="xref py py-obj docutils literal"><span class="pre">items</span></code></a> method. Used in conjunction with the <em>kwargs</em>
    157. 

  157. parameters to select the axes which span the items that
    158. 

  158. would be identified by this call of the field&#8217;s <a class="reference internal" href="cf.Field.items.html#cf.Field.items" title="cf.Field.items"><code class="xref py py-obj docutils literal"><span class="pre">items</span></code></a>
    159. 

  159. method: <code class="docutils literal"><span class="pre">f.items(items=axes,</span> <span class="pre">axes=None,</span> <span class="pre">**kwargs)</span></code>. See
    160. 

  160. <a class="reference internal" href="cf.Field.items.html#cf.Field.items" title="cf.Field.items"><code class="xref py py-obj docutils literal"><span class="pre">cf.Field.items</span></code></a> for details.</p>
    161. 

  161. <blockquote>
    162. 

  162. <div><dl class="docutils">
    163. 

  163. <dt><em>Example:</em></dt>
    164. 

  164. <dd><p class="first last">To select the axes spanned by one dimensionsal time
    165. 

  165. coordinates: <code class="docutils literal"><span class="pre">f.remove_axes('T',</span> <span class="pre">ndim=1)</span></code>.</p>
    166. 

  166. </dd>
    167. 

  167. </dl>
    168. 

  168. </div></blockquote>
    169. 

  169. </li>
    170. 

  170. </ul>
    171. 

  171. </div></blockquote>
    172. 

  172. <p class="last">If <em>axes</em> is a sequence of any combination of the above then
    173. 

  173. the selected axes are the union of those selected by each
    174. 

  174. element of the sequence. If the sequence is empty then no axes
    175. 

  175. are selected.</p>
    176. 

  176. </dd>
    177. 

  177. <dt>size: optional</dt>
    178. 

  178. <dd><p class="first">Select axes whose sizes equal <em>size</em>. Axes whose sizes lie
    179. 

  179. within a range sizes may be selected if <em>size</em> is a <a class="reference internal" href="../classes/cf.Query.html#cf.Query" title="cf.Query"><code class="xref py py-obj docutils literal"><span class="pre">cf.Query</span></code></a>
    180. 

  180. object.</p>
    181. 

  181. <blockquote class="last">
    182. 

  182. <div><dl class="docutils">
    183. 

  183. <dt><em>Example:</em>        </dt>
    184. 

  184. <dd><p class="first last"><code class="docutils literal"><span class="pre">size=1</span></code> selects size 1 axes.</p>
    185. 

  185. </dd>
    186. 

  186. <dt><em>Example:</em></dt>
    187. 

  187. <dd><p class="first last"><code class="docutils literal"><span class="pre">size=cf.ge(2)</span></code> selects axes with sizes greater than 1
    188. 

  188. (see <a class="reference internal" href="cf.ge.html#cf.ge" title="cf.ge"><code class="xref py py-obj docutils literal"><span class="pre">cf.ge</span></code></a>).</p>
    189. 

  189. </dd>
    190. 

  190. </dl>
    191. 

  191. </div></blockquote>
    192. 

  192. </dd>
    193. 

  193. </dl>
    194. 

  194. </td>
    195. 

  195. </tr>
    196. 

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

  197. <dt>out: set</dt>
    198. 

  198. <dd><p class="first last">The removed axes. The set may be empty.</p>
    199. 

  199. </dd>
    200. 

  200. </dl>
    201. 

  201. </td>
    202. 

  202. </tr>
    203. 

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

  204. </tr>
    205. 

  205. </tbody>
    206. 

  206. </table>
    207. 

  207. </dd></dl>
    208. 

  208. 

  209. </div>
    210. 

  210. 

  211. 

  212.           </div>
    213. 

  213.         </div>
    214. 

  214.       </div>
    215. 

  215.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    216. 

  216.         <div class="sphinxsidebarwrapper">
    217. 

  217.   <h4>Previous topic</h4>
    218. 

  218.   <p class="topless"><a href="cf.Field.period.html"
    219. 

  219.                         title="previous chapter">cf.Field.period</a></p>
    220. 

  220.   <h4>Next topic</h4>
    221. 

  221.   <p class="topless"><a href="cf.Field.remove_axis.html"
    222. 

  222.                         title="next chapter">cf.Field.remove_axis</a></p>
    223. 

  223.   <div role="note" aria-label="source link">
    224. 

  224.     <h3>This Page</h3>
    225. 

  225.     <ul class="this-page-menu">
    226. 

  226.       <li><a href="../_sources/generated/cf.Field.remove_axes.txt"
    227. 

  227.             rel="nofollow">Show Source</a></li>
    228. 

  228.     </ul>
    229. 

  229.    </div>
    230. 

  230. <div id="searchbox" style="display: none" role="search">
    231. 

  231.   <h3>Quick search</h3>
    232. 

  232.     <form class="search" action="../search.html" method="get">
    233. 

  233.       <input type="text" name="q" />
    234. 

  234.       <input type="submit" value="Go" />
    235. 

  235.       <input type="hidden" name="check_keywords" value="yes" />
    236. 

  236.       <input type="hidden" name="area" value="default" />
    237. 

  237.     </form>
    238. 

  238. </div>
    239. 

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

  240.         </div>
    241. 

  241.       </div>
    242. 

  242.       <div class="clearer"></div>
    243. 

  243.     </div>
    244. 

  244.     <div class="related" role="navigation" aria-label="related navigation">
    245. 

  245.       <h3>Navigation</h3>
    246. 

  246.       <ul>
    247. 

  247.         <li class="right" style="margin-right: 10px">
    248. 

  248.           <a href="../genindex.html" title="General Index"
    249. 

  249.              >index</a></li>
    250. 

  250.         <li class="right" >
    251. 

  251.           <a href="cf.Field.remove_axis.html" title="cf.Field.remove_axis"
    252. 

  252.              >next</a> |</li>
    253. 

  253.         <li class="right" >
    254. 

  254.           <a href="cf.Field.period.html" title="cf.Field.period"
    255. 

  255.              >previous</a> |</li>
    256. 

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

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

  258. <!--
    259. 

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

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

  261. 

  262.       <option value="../../1.0/index.html">1.0
    263. 

  263. 

  264.       <option value="../../0.9.9/index.html">0.9.9
    265. 

  265. 

  266.       <option value="../../0.9.8.3/index.html">0.9.8.3
    267. 

  267. 

  268.       <option value="../../archive.html">Archive
    269. 

  269. 

  270.       </select>
    271. 

  271.   </li>
    272. 

  272. -->
    273. 

  273.   
    274. 

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

  275. 

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

  277.           <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>
    278. 

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

  279.       </ul>
    280. 

  280.     </div>
    281. 

  281.     <div class="footer" role="contentinfo">
    282. 

  282.         &copy; Copyright 2016, David Hassell.
    283. 

  283.       Last updated on Aug 23, 2016.
    284. 

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

  285.     </div>
    286. 

  286.   </body>
    287. 

  287. </html>
    288.