PageRenderTime 42ms CodeModel.GetById 9ms RepoModel.GetById 0ms app.codeStats 0ms

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

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 229 lines | 185 code | 14 blank | 30 comment | 0 complexity | df654869992f4d9ac000340389a41ac1 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.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.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.tan" href="cf.Field.tan.html" />
    31. 

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

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

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

  44.           <a href="cf.Field.cos.html" title="cf.Field.cos"
    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-sin">
    78. 

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

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

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

  81. <code class="descclassname">Field.</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.2.3/cf/variable.py#variable.py-5507"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Field.sin" title="Permalink to this definition">Âś</a></dt>
    82. 

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

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

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

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

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

  87. <p>The Units are changed to &#8216;1&#8217; (nondimensionsal).</p>
    88. 

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

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

  90. <p class="last"><a class="reference internal" href="cf.Field.cos.html#cf.Field.cos" title="cf.Field.cos"><code class="xref py py-obj docutils literal"><span class="pre">cos</span></code></a>, <a class="reference internal" href="cf.Field.tan.html#cf.Field.tan" title="cf.Field.tan"><code class="xref py py-obj docutils literal"><span class="pre">tan</span></code></a></p>
    91. 

  91. </div>
    92. 

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

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

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

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

  96. <tr class="field-odd field"><th class="field-name">Examples 1:</th><td class="field-body"></td>
    97. 

  97. </tr>
    98. 

  98. </tbody>
    99. 

  99. </table>
    100. 

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

  101. </pre></div>
    102. 

  102. </div>
    103. 

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

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

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

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

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

  108. <dt>i: <a class="reference external" href="http://docs.python.org/2.7/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></a>, optional</dt>
    109. 

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

  110. field is created. In either case, a field is
    111. 

  111. returned.</p>
    112. 

  112. </dd>
    113. 

  113. </dl>
    114. 

  114. </td>
    115. 

  115. </tr>
    116. 

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

  117. <dt>out: <a class="reference internal" href="../classes/cf.Field.html#cf.Field" title="cf.Field"><code class="xref py py-obj docutils literal"><span class="pre">cf.Field</span></code></a></dt>
    118. 

  118. <dd><p class="first last">The field with the sine of data array values.</p>
    119. 

  119. </dd>
    120. 

  120. </dl>
    121. 

  121. </td>
    122. 

  122. </tr>
    123. 

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

  124. </tr>
    125. 

  125. </tbody>
    126. 

  126. </table>
    127. 

  127. <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>
    128. 

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

  129. <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>
    130. 

  130. <span class="go">[[-90 0 90 --]]</span>
    131. 

  131. <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>
    132. 

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

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

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

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

  136. </pre></div>
    137. 

  137. </div>
    138. 

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

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

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

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

  142. <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>
    143. 

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

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

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

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

  147. </pre></div>
    148. 

  148. </div>
    149. 

  149. </dd></dl>
    150. 

  150. 

  151. </div>
    152. 

  152. 

  153. 

  154.           </div>
    155. 

  155.         </div>
    156. 

  156.       </div>
    157. 

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

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

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

  160.   <p class="topless"><a href="cf.Field.cos.html"
    161. 

  161.                         title="previous chapter">cf.Field.cos</a></p>
    162. 

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

  163.   <p class="topless"><a href="cf.Field.tan.html"
    164. 

  164.                         title="next chapter">cf.Field.tan</a></p>
    165. 

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

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

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

  168.       <li><a href="../_sources/generated/cf.Field.sin.txt"
    169. 

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

  170.     </ul>
    171. 

  171.    </div>
    172. 

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

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

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

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

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

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

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

  179.     </form>
    180. 

  180. </div>
    181. 

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

  182.         </div>
    183. 

  183.       </div>
    184. 

  184.       <div class="clearer"></div>
    185. 

  185.     </div>
    186. 

  186.     <div class="related" role="navigation" aria-label="related navigation">
    187. 

  187.       <h3>Navigation</h3>
    188. 

  188.       <ul>
    189. 

  189.         <li class="right" style="margin-right: 10px">
    190. 

  190.           <a href="../genindex.html" title="General Index"
    191. 

  191.              >index</a></li>
    192. 

  192.         <li class="right" >
    193. 

  193.           <a href="cf.Field.tan.html" title="cf.Field.tan"
    194. 

  194.              >next</a> |</li>
    195. 

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

  196.           <a href="cf.Field.cos.html" title="cf.Field.cos"
    197. 

  197.              >previous</a> |</li>
    198. 

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

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

  200. <!--
    201. 

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

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

  203. 

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

  205. 

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

  207. 

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

  209. 

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

  211. 

  212.       </select>
    213. 

  213.   </li>
    214. 

  214. -->
    215. 

  215.   
    216. 

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

  217. 

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

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

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

  221.       </ul>
    222. 

  222.     </div>
    223. 

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

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

  225.       Last updated on Aug 23, 2016.
    226. 

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

  227.     </div>
    228. 

  228.   </body>
    229. 

  229. </html>
    230.