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

/docs/1.1/generated/cf.Domain.insert_axis.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 212 lines | 168 code | 14 blank | 30 comment | 0 complexity | 48fa6b73e3e59013edaeeb7d2acdaafa 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.Domain.insert_axis &mdash; Documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="../_static/default.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',
    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="http://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.Domain" href="../classes/cf.Domain.html" />
    30. 

  30.     <link rel="next" title="cf.Domain.insert_coord" href="cf.Domain.insert_coord.html" />
    31. 

  31.     <link rel="prev" title="cf.Domain.insert_aux" href="cf.Domain.insert_aux.html" /> 
    32. 

  32.   </head>
    33. 

  33.   <body>
    34. 

  34.     <div class="related">
    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.Domain.insert_coord.html" title="cf.Domain.insert_coord"
    42. 

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

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

  44.           <a href="cf.Domain.insert_aux.html" title="cf.Domain.insert_aux"
    45. 

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

  46.   <li><a target="_blank" href="http://cfpython.bitbucket.org">cf-python 1.1</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><a href="../index.html">Documentation</a> &raquo;</li>
    64. 

  64. 

  65.           <li><a href="../reference.html" >Reference manual</a> &raquo;</li>
    66. 

  66.           <li><a href="../class.html" >Classes of the <tt class="docutils literal"><span class="pre">cf</span></tt> module</a> &raquo;</li>
    67. 

  67.           <li><a href="../classes/cf.Domain.html" accesskey="U">cf.Domain</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">
    75. 

  75.             
    76. 

  76.   <div class="section" id="cf-domain-insert-axis">
    77. 

  77. <h1>cf.Domain.insert_axis<a class="headerlink" href="#cf-domain-insert-axis" title="Permalink to this headline">Âś</a></h1>
    78. 

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

  79. <dt id="cf.Domain.insert_axis">
    80. 

  80. <tt class="descclassname">Domain.</tt><tt class="descname">insert_axis</tt><big>(</big><em>size</em>, <em>key=None</em>, <em>replace=True</em><big>)</big><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1/cf/domain.py#cl-1500"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Domain.insert_axis" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>Insert an axis into the domain in place.</p>
    82. 

  82. <p>This method has exactly the same interface, functionality and outputs
    83. 

  83. as <a class="reference internal" href="cf.Field.insert_axis.html#cf.Field.insert_axis" title="cf.Field.insert_axis"><tt class="xref py py-obj docutils literal"><span class="pre">cf.Field.insert_axis</span></tt></a>. Therefore see <a class="reference internal" href="cf.Field.insert_axis.html#cf.Field.insert_axis" title="cf.Field.insert_axis"><tt class="xref py py-obj docutils literal"><span class="pre">cf.Field.insert_axis</span></tt></a> for
    84. 

  84. the full documentation details.</p>
    85. 

  85. <div class="admonition seealso">
    86. 

  86. <p class="first admonition-title">See also</p>
    87. 

  87. <p class="last"><a class="reference internal" href="cf.Domain.insert_aux.html#cf.Domain.insert_aux" title="cf.Domain.insert_aux"><tt class="xref py py-obj docutils literal"><span class="pre">insert_aux</span></tt></a>, insert_measure`, insert_dim`, insert_ref`</p>
    88. 

  88. </div>
    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">Examples 1:</th><td class="field-body"></td>
    94. 

  94. </tr>
    95. 

  95. </tbody>
    96. 

  96. </table>
    97. 

  97. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">d</span><span class="o">.</span><span class="n">insert_axis</span><span class="p">(</span><span class="mi">24</span><span class="p">)</span>
    98. 

  98. </pre></div>
    99. 

  99. </div>
    100. 

  100. <table class="docutils field-list" frame="void" rules="none">
    101. 

  101. <col class="field-name" />
    102. 

  102. <col class="field-body" />
    103. 

  103. <tbody valign="top">
    104. 

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

  105. <dt>size <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
    106. 

  106. <dd><p class="first last">The size of the new axis.</p>
    107. 

  107. </dd>
    108. 

  108. <dt>key <span class="classifier-delimiter">:</span> <span class="classifier">str, optional</span></dt>
    109. 

  109. <dd><p class="first last">The domain identifier for the new axis. By default a new,
    110. 

  110. unique identifier is generated.</p>
    111. 

  111. </dd>
    112. 

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

  113. <dd><p class="first last">If False then do not replace an existing axis with the same
    114. 

  114. identifier but a different size. By default an existing axis
    115. 

  115. with the same identifier is changed to have the new size.</p>
    116. 

  116. </dd>
    117. 

  117. </dl>
    118. 

  118. </td>
    119. 

  119. </tr>
    120. 

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

  121. <dt>out :</dt>
    122. 

  122. <dd><p class="first last">The domain identifier of the new axis.</p>
    123. 

  123. </dd>
    124. 

  124. </dl>
    125. 

  125. </td>
    126. 

  126. </tr>
    127. 

  127. <tr class="field-odd field"><th class="field-name">Examples 2:</th><td class="field-body"></td>
    128. 

  128. </tr>
    129. 

  129. </tbody>
    130. 

  130. </table>
    131. 

  131. <p>See <a class="reference internal" href="cf.Field.insert_axis.html#cf.Field.insert_axis" title="cf.Field.insert_axis"><tt class="xref py py-obj docutils literal"><span class="pre">cf.Field.insert_axis</span></tt></a>.</p>
    132. 

  132. </dd></dl>
    133. 

    134. 

  134. </div>
    135. 

    136. 

    137. 

  137.           </div>
    138. 

  138.         </div>
    139. 

  139.       </div>
    140. 

  140.       <div class="sphinxsidebar">
    141. 

  141.         <div class="sphinxsidebarwrapper">
    142. 

  142.   <h4>Previous topic</h4>
    143. 

  143.   <p class="topless"><a href="cf.Domain.insert_aux.html"
    144. 

  144.                         title="previous chapter">cf.Domain.insert_aux</a></p>
    145. 

  145.   <h4>Next topic</h4>
    146. 

  146.   <p class="topless"><a href="cf.Domain.insert_coord.html"
    147. 

  147.                         title="next chapter">cf.Domain.insert_coord</a></p>
    148. 

  148.   <h3>This Page</h3>
    149. 

  149.   <ul class="this-page-menu">
    150. 

  150.     <li><a href="../_sources/generated/cf.Domain.insert_axis.txt"
    151. 

  151.            rel="nofollow">Show Source</a></li>
    152. 

  152.   </ul>
    153. 

  153. <div id="searchbox" style="display: none">
    154. 

  154.   <h3>Quick search</h3>
    155. 

  155.     <form class="search" action="../search.html" method="get">
    156. 

  156.       <input type="text" name="q" />
    157. 

  157.       <input type="submit" value="Go" />
    158. 

  158.       <input type="hidden" name="check_keywords" value="yes" />
    159. 

  159.       <input type="hidden" name="area" value="default" />
    160. 

  160.     </form>
    161. 

  161.     <p class="searchtip" style="font-size: 90%">
    162. 

  162.     Enter search terms or a module, class or function name.
    163. 

  163.     </p>
    164. 

  164. </div>
    165. 

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

  166.         </div>
    167. 

  167.       </div>
    168. 

  168.       <div class="clearer"></div>
    169. 

  169.     </div>
    170. 

  170.     <div class="related">
    171. 

  171.       <h3>Navigation</h3>
    172. 

  172.       <ul>
    173. 

  173.         <li class="right" style="margin-right: 10px">
    174. 

  174.           <a href="../genindex.html" title="General Index"
    175. 

  175.              >index</a></li>
    176. 

  176.         <li class="right" >
    177. 

  177.           <a href="cf.Domain.insert_coord.html" title="cf.Domain.insert_coord"
    178. 

  178.              >next</a> |</li>
    179. 

  179.         <li class="right" >
    180. 

  180.           <a href="cf.Domain.insert_aux.html" title="cf.Domain.insert_aux"
    181. 

  181.              >previous</a> |</li>
    182. 

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

  183. <!--
    184. 

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

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

    187. 

  187.       <option value="../../1.0/index.html">1.0
    188. 

    189. 

  189.       <option value="../../0.9.9/index.html">0.9.9
    190. 

    191. 

  191.       <option value="../../0.9.8.3/index.html">0.9.8.3
    192. 

    193. 

  193.       <option value="../../archive.html">Archive
    194. 

    195. 

  195.       </select>
    196. 

  196.   </li>
    197. 

  197. -->
    198. 

  198.   
    199. 

  199.         <li><a href="../index.html">Documentation</a> &raquo;</li>
    200. 

    201. 

  201.           <li><a href="../reference.html" >Reference manual</a> &raquo;</li>
    202. 

  202.           <li><a href="../class.html" >Classes of the <tt class="docutils literal"><span class="pre">cf</span></tt> module</a> &raquo;</li>
    203. 

  203.           <li><a href="../classes/cf.Domain.html" >cf.Domain</a> &raquo;</li> 
    204. 

  204.       </ul>
    205. 

  205.     </div>
    206. 

  206.     <div class="footer">
    207. 

  207.         &copy; Copyright 2015, David Hassell.
    208. 

  208.       Last updated on Oct 28, 2015.
    209. 

  209.       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
    210. 

  210.     </div>
    211. 

  211.   </body>
    212. 

  212. </html>
    213.