PageRenderTime 47ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.1.10/generated/cf.Field.remove_axis.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 287 lines | 243 code | 14 blank | 30 comment | 0 complexity | 024dcd9d39765d3ab50243eb613ba339 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_axis &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.10',
    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.aux" href="cf.Field.aux.html" />
    31. 

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

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

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

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

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

  46.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.10</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.Field.html" accesskey="U">cf.Field</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-field-remove-axis">
    77. 

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

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

  79. <dt id="cf.Field.remove_axis">
    80. 

  80. <code class="descclassname">Field.</code><code class="descname">remove_axis</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.1.10/cf/field.py#field.py-10262"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.remove_axis" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>Remove and return a unique axis from the field.</p>
    82. 

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

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

  84. <p>If the axis has size greater than 1 then it is not possible to remove
    85. 

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

  86. coordinate or cell measure object of the field.</p>
    87. 

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

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

  89. <p class="last"><a class="reference internal" href="cf.Field.axis.html#cf.Field.axis" title="cf.Field.axis"><code class="xref py py-obj docutils literal"><span class="pre">axis</span></code></a>, <a class="reference internal" href="cf.Field.remove_axes.html#cf.Field.remove_axes" title="cf.Field.remove_axes"><code class="xref py py-obj docutils literal"><span class="pre">remove_axes</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>
    90. 

  90. </div>
    91. 

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

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

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

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

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

  96. <dt>axes, kwargs <span class="classifier-delimiter">:</span> <span class="classifier"><em>optional</em></span></dt>
    97. 

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

  98. of:</p>
    99. 

  99. <blockquote>
    100. 

  100. <div><ul class="simple">
    101. 

  101. <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
    102. 

  102. then all axes are selected. This is the default.</li>
    103. 

  103. </ul>
    104. 

  104. </div></blockquote>
    105. 

  105. <blockquote>
    106. 

  106. <div><ul>
    107. 

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

  108. the given position in the list of axes of the field&#8217;s data
    109. 

  109. array.</p>
    110. 

  110. <blockquote>
    111. 

  111. <div><dl class="docutils">
    112. 

  112. <dt><em>Example:</em></dt>
    113. 

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

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

  115. </dd>
    116. 

  116. </dl>
    117. 

  117. </div></blockquote>
    118. 

  118. </li>
    119. 

  119. </ul>
    120. 

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

  121. <blockquote>
    122. 

  122. <div><ul>
    123. 

  123. <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
    124. 

  124. corresponding to the given positions in the list of axes
    125. 

  125. of the field&#8217;s data array.</p>
    126. 

  126. <blockquote>
    127. 

  127. <div><dl class="docutils">
    128. 

  128. <dt><em>Example:</em> </dt>
    129. 

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

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

  131. </dd>
    132. 

  132. </dl>
    133. 

  133. </div></blockquote>
    134. 

  134. </li>
    135. 

  135. </ul>
    136. 

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

  137. <blockquote>
    138. 

  138. <div><ul>
    139. 

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

  140. <blockquote>
    141. 

  141. <div><dl class="docutils">
    142. 

  142. <dt><em>Example:</em></dt>
    143. 

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

  144. </dd>
    145. 

  145. </dl>
    146. 

  146. </div></blockquote>
    147. 

  147. </li>
    148. 

  148. </ul>
    149. 

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

  150. <blockquote>
    151. 

  151. <div><ul>
    152. 

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

  153. <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>
    154. 

  154. parameters to select the axes which span the items that
    155. 

  155. 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>
    156. 

  156. 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
    157. 

  157. <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>
    158. 

  158. <blockquote>
    159. 

  159. <div><dl class="docutils">
    160. 

  160. <dt><em>Example:</em></dt>
    161. 

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

  162. coordinates: <code class="docutils literal"><span class="pre">f.remove_axis('T',</span> <span class="pre">ndim=1)</span></code>.</p>
    163. 

  163. </dd>
    164. 

  164. </dl>
    165. 

  165. </div></blockquote>
    166. 

  166. </li>
    167. 

  167. </ul>
    168. 

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

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

  170. the selected axes are the union of those selected by each
    171. 

  171. element of the sequence. If the sequence is empty then no axes
    172. 

  172. are selected.</p>
    173. 

  173. </dd>
    174. 

  174. <dt>size <span class="classifier-delimiter">:</span> <span class="classifier"><em>optional</em></span></dt>
    175. 

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

  176. 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>
    177. 

  177. object.</p>
    178. 

  178. <blockquote class="last">
    179. 

  179. <div><dl class="docutils">
    180. 

  180. <dt><em>Example:</em>        </dt>
    181. 

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

  182. </dd>
    183. 

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

  184. <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
    185. 

  185. (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>
    186. 

  186. </dd>
    187. 

  187. </dl>
    188. 

  188. </div></blockquote>
    189. 

  189. </dd>
    190. 

  190. </dl>
    191. 

  191. </td>
    192. 

  192. </tr>
    193. 

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

  194. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">str</span></dt>
    195. 

  195. <dd><p class="first last">The domain identifier of the removed axis, or <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 there
    196. 

  196. isn&#8217;t one.</p>
    197. 

  197. </dd>
    198. 

  198. </dl>
    199. 

  199. </td>
    200. 

  200. </tr>
    201. 

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

  202. </tr>
    203. 

  203. </tbody>
    204. 

  204. </table>
    205. 

  205. </dd></dl>
    206. 

  206. 

  207. </div>
    208. 

  208. 

  209. 

  210.           </div>
    211. 

  211.         </div>
    212. 

  212.       </div>
    213. 

  213.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    214. 

  214.         <div class="sphinxsidebarwrapper">
    215. 

  215.   <h4>Previous topic</h4>
    216. 

  216.   <p class="topless"><a href="cf.Field.remove_axes.html"
    217. 

  217.                         title="previous chapter">cf.Field.remove_axes</a></p>
    218. 

  218.   <h4>Next topic</h4>
    219. 

  219.   <p class="topless"><a href="cf.Field.aux.html"
    220. 

  220.                         title="next chapter">cf.Field.aux</a></p>
    221. 

  221.   <div role="note" aria-label="source link">
    222. 

  222.     <h3>This Page</h3>
    223. 

  223.     <ul class="this-page-menu">
    224. 

  224.       <li><a href="../_sources/generated/cf.Field.remove_axis.txt"
    225. 

  225.             rel="nofollow">Show Source</a></li>
    226. 

  226.     </ul>
    227. 

  227.    </div>
    228. 

  228. <div id="searchbox" style="display: none" role="search">
    229. 

  229.   <h3>Quick search</h3>
    230. 

  230.     <form class="search" action="../search.html" method="get">
    231. 

  231.       <input type="text" name="q" />
    232. 

  232.       <input type="submit" value="Go" />
    233. 

  233.       <input type="hidden" name="check_keywords" value="yes" />
    234. 

  234.       <input type="hidden" name="area" value="default" />
    235. 

  235.     </form>
    236. 

  236.     <p class="searchtip" style="font-size: 90%">
    237. 

  237.     Enter search terms or a module, class or function name.
    238. 

  238.     </p>
    239. 

  239. </div>
    240. 

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

  241.         </div>
    242. 

  242.       </div>
    243. 

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

  244.     </div>
    245. 

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

  246.       <h3>Navigation</h3>
    247. 

  247.       <ul>
    248. 

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

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

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

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

  252.           <a href="cf.Field.aux.html" title="cf.Field.aux"
    253. 

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

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

  255.           <a href="cf.Field.remove_axes.html" title="cf.Field.remove_axes"
    256. 

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

  257.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1.10</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 Jun 23, 2016.
    284. 

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

  285.     </div>
    286. 

  286.   </body>
    287. 

  287. </html>
    288.