PageRenderTime 45ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/1.1.8/generated/cf.DimensionCoordinate.get_bounds.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 215 lines | 171 code | 14 blank | 30 comment | 0 complexity | f7326cb0d32c742a624a9f69125bd5ef 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.DimensionCoordinate.get_bounds &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.DimensionCoordinate" href="../classes/cf.DimensionCoordinate.html" />
    30. 

  30.     <link rel="next" title="cf.DimensionCoordinate.getprop" href="cf.DimensionCoordinate.getprop.html" />
    31. 

  31.     <link rel="prev" title="cf.DimensionCoordinate.flip" href="cf.DimensionCoordinate.flip.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.DimensionCoordinate.getprop.html" title="cf.DimensionCoordinate.getprop"
    42. 

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

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

  44.           <a href="cf.DimensionCoordinate.flip.html" title="cf.DimensionCoordinate.flip"
    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.DimensionCoordinate.html" accesskey="U">cf.DimensionCoordinate</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-dimensioncoordinate-get-bounds">
    77. 

  77. <h1>cf.DimensionCoordinate.get_bounds<a class="headerlink" href="#cf-dimensioncoordinate-get-bounds" title="Permalink to this headline">Âś</a></h1>
    78. 

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

  79. <dt id="cf.DimensionCoordinate.get_bounds">
    80. 

  80. <code class="descclassname">DimensionCoordinate.</code><code class="descname">get_bounds</code><span class="sig-paren">(</span><em>create=False</em>, <em>insert=False</em>, <em>bound=None</em>, <em>cellsize=None</em>, <em>copy=True</em><span class="sig-paren">)</span><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.1.8/cf/coordinate.py#coordinate.py-2729"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.DimensionCoordinate.get_bounds" title="Permalink to this definition">Âś</a></dt>
    81. 

  81. <dd><p>Get the cell bounds.</p>
    82. 

  82. <p>Either return its existing bounds or, if there are none, optionally
    83. 

  83. create bounds based on the coordinate array values.</p>
    84. 

  84. <table class="docutils field-list" frame="void" rules="none">
    85. 

  85. <col class="field-name" />
    86. 

  86. <col class="field-body" />
    87. 

  87. <tbody valign="top">
    88. 

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

  89. <dt>create <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
    90. 

  90. <dd><p class="first last">If True then create bounds if and only if the the dimension
    91. 

  91. coordinate does not already have them. Bounds for Voronoi
    92. 

  92. cells are created unless <em>bound</em> is set.</p>
    93. 

  93. </dd>
    94. 

  94. <dt>insert <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional </span></dt>
    95. 

  95. <dd><p class="first last">If True then insert the created bounds into the coordinate in
    96. 

  96. place. By default the created bounds are not inserted. Ignored
    97. 

  97. if <em>create</em> is not True.</p>
    98. 

  98. </dd>
    99. 

  99. <dt>bound <span class="classifier-delimiter">:</span> <span class="classifier"><em>optional</em></span></dt>
    100. 

  100. <dd><p class="first last">If set to an upper or lower bound for the whole array, then
    101. 

  101. bounds are created which include this value and for which each
    102. 

  102. array element is in the centre of its bounds. By default
    103. 

  103. bounds for Voronoi cells are created. Ignored if <em>create</em> is
    104. 

  104. not True.</p>
    105. 

  105. </dd>
    106. 

  106. <dt>copy <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional</span></dt>
    107. 

  107. <dd><p class="first last">If False then the returned bounds are not independent of the
    108. 

  108. existing bounds, if any, or those inserted, if <em>create</em> and
    109. 

  109. <em>insert</em> are both True. By default the returned bounds are
    110. 

  110. independent.</p>
    111. 

  111. </dd>
    112. 

  112. </dl>
    113. 

  113. </td>
    114. 

  114. </tr>
    115. 

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

  116. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">cf.CoordinateBounds</span></dt>
    117. 

  117. <dd><p class="first last">The existing or created bounds.</p>
    118. 

  118. </dd>
    119. 

  119. </dl>
    120. 

  120. </td>
    121. 

  121. </tr>
    122. 

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

  123. </tr>
    124. 

  124. </tbody>
    125. 

  125. </table>
    126. 

  126. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">get_bounds</span><span class="p">()</span>
    127. 

  127. <span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">get_bounds</span><span class="p">(</span><span class="n">create</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    128. 

  128. <span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">get_bounds</span><span class="p">(</span><span class="n">create</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">bound</span><span class="o">=</span><span class="mi">60</span><span class="p">)</span>
    129. 

  129. <span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">get_bounds</span><span class="p">(</span><span class="n">create</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">insert</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    130. 

  130. <span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">get_bounds</span><span class="p">(</span><span class="n">create</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">bound</span><span class="o">=-</span><span class="mf">9000.0</span><span class="p">,</span> <span class="n">insert</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">copy</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
    131. 

  131. </pre></div>
    132. 

  132. </div>
    133. 

  133. </dd></dl>
    134. 

  134. 

  135. </div>
    136. 

  136. 

  137. 

  138.           </div>
    139. 

  139.         </div>
    140. 

  140.       </div>
    141. 

  141.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    142. 

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

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

  144.   <p class="topless"><a href="cf.DimensionCoordinate.flip.html"
    145. 

  145.                         title="previous chapter">cf.DimensionCoordinate.flip</a></p>
    146. 

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

  147.   <p class="topless"><a href="cf.DimensionCoordinate.getprop.html"
    148. 

  148.                         title="next chapter">cf.DimensionCoordinate.getprop</a></p>
    149. 

  149.   <div role="note" aria-label="source link">
    150. 

  150.     <h3>This Page</h3>
    151. 

  151.     <ul class="this-page-menu">
    152. 

  152.       <li><a href="../_sources/generated/cf.DimensionCoordinate.get_bounds.txt"
    153. 

  153.             rel="nofollow">Show Source</a></li>
    154. 

  154.     </ul>
    155. 

  155.    </div>
    156. 

  156. <div id="searchbox" style="display: none" role="search">
    157. 

  157.   <h3>Quick search</h3>
    158. 

  158.     <form class="search" action="../search.html" method="get">
    159. 

  159.       <input type="text" name="q" />
    160. 

  160.       <input type="submit" value="Go" />
    161. 

  161.       <input type="hidden" name="check_keywords" value="yes" />
    162. 

  162.       <input type="hidden" name="area" value="default" />
    163. 

  163.     </form>
    164. 

  164.     <p class="searchtip" style="font-size: 90%">
    165. 

  165.     Enter search terms or a module, class or function name.
    166. 

  166.     </p>
    167. 

  167. </div>
    168. 

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

  169.         </div>
    170. 

  170.       </div>
    171. 

  171.       <div class="clearer"></div>
    172. 

  172.     </div>
    173. 

  173.     <div class="related" role="navigation" aria-label="related navigation">
    174. 

  174.       <h3>Navigation</h3>
    175. 

  175.       <ul>
    176. 

  176.         <li class="right" style="margin-right: 10px">
    177. 

  177.           <a href="../genindex.html" title="General Index"
    178. 

  178.              >index</a></li>
    179. 

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

  180.           <a href="cf.DimensionCoordinate.getprop.html" title="cf.DimensionCoordinate.getprop"
    181. 

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

  182.         <li class="right" >
    183. 

  183.           <a href="cf.DimensionCoordinate.flip.html" title="cf.DimensionCoordinate.flip"
    184. 

  184.              >previous</a> |</li>
    185. 

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

  186. <!--
    187. 

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

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

  189. 

  190.       <option value="../../1.0/index.html">1.0
    191. 

  191. 

  192.       <option value="../../0.9.9/index.html">0.9.9
    193. 

  193. 

  194.       <option value="../../0.9.8.3/index.html">0.9.8.3
    195. 

  195. 

  196.       <option value="../../archive.html">Archive
    197. 

  197. 

  198.       </select>
    199. 

  199.   </li>
    200. 

  200. -->
    201. 

  201.   
    202. 

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

  203. 

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

  205.           <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>
    206. 

  206.           <li class="nav-item nav-item-3"><a href="../classes/cf.DimensionCoordinate.html" >cf.DimensionCoordinate</a> &raquo;</li> 
    207. 

  207.       </ul>
    208. 

  208.     </div>
    209. 

  209.     <div class="footer" role="contentinfo">
    210. 

  210.         &copy; Copyright 2016, David Hassell.
    211. 

  211.       Last updated on May 18, 2016.
    212. 

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

  213.     </div>
    214. 

  214.   </body>
    215. 

  215. </html>
    216.