PageRenderTime 28ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/1.1.8/generated/cf.CoordinateBounds.sin.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 230 lines | 186 code | 14 blank | 30 comment | 0 complexity | 2c8cf21fdaa9bca9930ed7904282b28d 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.CoordinateBounds.sin &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.CoordinateBounds" href="../classes/cf.CoordinateBounds.html" />
    30. 

  30.     <link rel="next" title="cf.CoordinateBounds.squeeze" href="cf.CoordinateBounds.squeeze.html" />
    31. 

  31.     <link rel="prev" title="cf.CoordinateBounds.setprop" href="cf.CoordinateBounds.setprop.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.CoordinateBounds.squeeze.html" title="cf.CoordinateBounds.squeeze"
    42. 

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

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

  44.           <a href="cf.CoordinateBounds.setprop.html" title="cf.CoordinateBounds.setprop"
    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.CoordinateBounds.html" accesskey="U">cf.CoordinateBounds</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-coordinatebounds-sin">
    77. 

  77. <h1>cf.CoordinateBounds.sin<a class="headerlink" href="#cf-coordinatebounds-sin" title="Permalink to this headline">Âś</a></h1>
    78. 

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

  79. <dt id="cf.CoordinateBounds.sin">
    80. 

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

  81. <dd><p>Take the trigonometric sine of the data array.</p>
    82. 

  82. <p>Units are accounted for in the calculation. For example, the the sine
    83. 

  83. of 90 degrees_east is 1.0, as is the sine of 1.57079632 radians. If
    84. 

  84. the units are not equivalent to radians (such as Kelvin) then they are
    85. 

  85. treated as if they were radians.</p>
    86. 

  86. <p>The Units are changed to &#8216;1&#8217; (nondimensionsal).</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.CoordinateBounds.cos.html#cf.CoordinateBounds.cos" title="cf.CoordinateBounds.cos"><code class="xref py py-obj docutils literal"><span class="pre">cos</span></code></a>, <code class="xref py py-obj docutils literal"><span class="pre">tan</span></code></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">Examples 1:</th><td class="field-body"></td>
    96. 

  96. </tr>
    97. 

  97. </tbody>
    98. 

  98. </table>
    99. 

  99. <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">sin</span><span class="p">()</span>
    100. 

  100. </pre></div>
    101. 

  101. </div>
    102. 

  102. <table class="docutils field-list" frame="void" rules="none">
    103. 

  103. <col class="field-name" />
    104. 

  104. <col class="field-body" />
    105. 

  105. <tbody valign="top">
    106. 

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

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

  108. <dd><p class="first last">If True then update the coordinate bounds in place. By default a new
    109. 

  109. coordinate bounds is created. In either case, a coordinate bounds is
    110. 

  110. returned.</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 coordinate bounds with the sine of data array values.</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 2:</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">f</span><span class="o">.</span><span class="n">Units</span>
    127. 

  127. <span class="go">&lt;CF Units: degrees_north&gt;</span>
    128. 

  128. <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">[[-90 0 90 --]]</span>
    130. 

  130. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">sin</span><span class="p">()</span>
    131. 

  131. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">Units</span>
    132. 

  132. <span class="go">&lt;CF Units: 1&gt;</span>
    133. 

  133. <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>
    134. 

  134. <span class="go">[[-1.0 0.0 1.0 --]]</span>
    135. 

  135. </pre></div>
    136. 

  136. </div>
    137. 

  137. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">Units</span>
    138. 

  138. <span class="go">&lt;CF Units: m s-1&gt;</span>
    139. 

  139. <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>
    140. 

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

  141. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">sin</span><span class="p">()</span>
    142. 

  142. <span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">Units</span>
    143. 

  143. <span class="go">&lt;CF Units: 1&gt;</span>
    144. 

  144. <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>
    145. 

  145. <span class="go">[[0.841470984808 0.909297426826 0.14112000806 --]]</span>
    146. 

  146. </pre></div>
    147. 

  147. </div>
    148. 

  148. </dd></dl>
    149. 

  149. 

  150. </div>
    151. 

  151. 

  152. 

  153.           </div>
    154. 

  154.         </div>
    155. 

  155.       </div>
    156. 

  156.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    157. 

  157.         <div class="sphinxsidebarwrapper">
    158. 

  158.   <h4>Previous topic</h4>
    159. 

  159.   <p class="topless"><a href="cf.CoordinateBounds.setprop.html"
    160. 

  160.                         title="previous chapter">cf.CoordinateBounds.setprop</a></p>
    161. 

  161.   <h4>Next topic</h4>
    162. 

  162.   <p class="topless"><a href="cf.CoordinateBounds.squeeze.html"
    163. 

  163.                         title="next chapter">cf.CoordinateBounds.squeeze</a></p>
    164. 

  164.   <div role="note" aria-label="source link">
    165. 

  165.     <h3>This Page</h3>
    166. 

  166.     <ul class="this-page-menu">
    167. 

  167.       <li><a href="../_sources/generated/cf.CoordinateBounds.sin.txt"
    168. 

  168.             rel="nofollow">Show Source</a></li>
    169. 

  169.     </ul>
    170. 

  170.    </div>
    171. 

  171. <div id="searchbox" style="display: none" role="search">
    172. 

  172.   <h3>Quick search</h3>
    173. 

  173.     <form class="search" action="../search.html" method="get">
    174. 

  174.       <input type="text" name="q" />
    175. 

  175.       <input type="submit" value="Go" />
    176. 

  176.       <input type="hidden" name="check_keywords" value="yes" />
    177. 

  177.       <input type="hidden" name="area" value="default" />
    178. 

  178.     </form>
    179. 

  179.     <p class="searchtip" style="font-size: 90%">
    180. 

  180.     Enter search terms or a module, class or function name.
    181. 

  181.     </p>
    182. 

  182. </div>
    183. 

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

  184.         </div>
    185. 

  185.       </div>
    186. 

  186.       <div class="clearer"></div>
    187. 

  187.     </div>
    188. 

  188.     <div class="related" role="navigation" aria-label="related navigation">
    189. 

  189.       <h3>Navigation</h3>
    190. 

  190.       <ul>
    191. 

  191.         <li class="right" style="margin-right: 10px">
    192. 

  192.           <a href="../genindex.html" title="General Index"
    193. 

  193.              >index</a></li>
    194. 

  194.         <li class="right" >
    195. 

  195.           <a href="cf.CoordinateBounds.squeeze.html" title="cf.CoordinateBounds.squeeze"
    196. 

  196.              >next</a> |</li>
    197. 

  197.         <li class="right" >
    198. 

  198.           <a href="cf.CoordinateBounds.setprop.html" title="cf.CoordinateBounds.setprop"
    199. 

  199.              >previous</a> |</li>
    200. 

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

  201. <!--
    202. 

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

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

  204. 

  205.       <option value="../../1.0/index.html">1.0
    206. 

  206. 

  207.       <option value="../../0.9.9/index.html">0.9.9
    208. 

  208. 

  209.       <option value="../../0.9.8.3/index.html">0.9.8.3
    210. 

  210. 

  211.       <option value="../../archive.html">Archive
    212. 

  212. 

  213.       </select>
    214. 

  214.   </li>
    215. 

  215. -->
    216. 

  216.   
    217. 

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

  218. 

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

  220.           <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>
    221. 

  221.           <li class="nav-item nav-item-3"><a href="../classes/cf.CoordinateBounds.html" >cf.CoordinateBounds</a> &raquo;</li> 
    222. 

  222.       </ul>
    223. 

  223.     </div>
    224. 

  224.     <div class="footer" role="contentinfo">
    225. 

  225.         &copy; Copyright 2016, David Hassell.
    226. 

  226.       Last updated on May 18, 2016.
    227. 

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

  228.     </div>
    229. 

  229.   </body>
    230. 

  230. </html>
    231.