PageRenderTime 34ms CodeModel.GetById 6ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/1.0/generated/cf.Data.sum.html

https://bitbucket.org/cfpython/cfpython.bitbucket.org
HTML | 188 lines | 164 code | 24 blank | 0 comment | 0 complexity | 15c93dad98b9138d7175a8a0bfe0216a 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.Data.sum &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.0',
    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.Data" href="../classes/cf.Data.html" />
    30. 

  30.     <link rel="next" title="cf.Data.sum_of_weights" href="cf.Data.sum_of_weights.html" />
    31. 

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

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

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

  44.           <a href="cf.Data.squeeze.html" title="cf.Data.squeeze"
    45. 

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

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

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

  48. 

  49.       <option value="../../1.0/index.html"selected>1.0
    50. 

  50. 

  51.       <option value="../../0.9.9/index.html">0.9.9
    52. 

  52. 

  53.       <option value="../../0.9.8.3/index.html">0.9.8.3
    54. 

  54. 

  55.       <option value="../../archive.html">Archive
    56. 

  56. 

  57.       </select>
    58. 

  58.   </li>
    59. 

  59.   
    60. 

  60.         <li><a href="../index.html">Documentation</a> &raquo;</li>
    61. 

  61. 

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

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

  64.           <li><a href="../classes/cf.Data.html" accesskey="U">cf.Data</a> &raquo;</li> 
    65. 

  65.       </ul>
    66. 

  66.     </div>  
    67. 

  67. 

  68.     <div class="document">
    69. 

  69.       <div class="documentwrapper">
    70. 

  70.         <div class="bodywrapper">
    71. 

  71.           <div class="body">
    72. 

  72.             
    73. 

  73.   <div class="section" id="cf-data-sum">
    74. 

  74. <h1>cf.Data.sum<a class="headerlink" href="#cf-data-sum" title="Permalink to this headline">Âś</a></h1>
    75. 

  75. <dl class="method">
    76. 

  76. <dt id="cf.Data.sum">
    77. 

  77. <tt class="descclassname">Data.</tt><tt class="descname">sum</tt><big>(</big><em>axes=None</em>, <em>squeeze=False</em>, <em>mtol=1</em>, <em>i=False</em><big>)</big><a class="reference external" href="https://bitbucket.org/cfpython/cf-python/src/v1.0/cf/data/data.py#cl-9044"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cf.Data.sum" title="Permalink to this definition">Âś</a></dt>
    78. 

  78. <dd><p>Collapse axes with their sum.</p>
    79. 

  79. <p>Missing data array elements are omitted from the calculation.</p>
    80. 

  80. <div class="admonition seealso">
    81. 

  81. <p class="first admonition-title">See also</p>
    82. 

  82. <p class="last"><a class="reference internal" href="cf.Data.max.html#cf.Data.max" title="cf.Data.max"><tt class="xref py py-obj docutils literal"><span class="pre">max</span></tt></a>, <a class="reference internal" href="cf.Data.min.html#cf.Data.min" title="cf.Data.min"><tt class="xref py py-obj docutils literal"><span class="pre">min</span></tt></a>, <a class="reference internal" href="cf.Data.mean.html#cf.Data.mean" title="cf.Data.mean"><tt class="xref py py-obj docutils literal"><span class="pre">mean</span></tt></a>, <a class="reference internal" href="cf.Data.mid_range.html#cf.Data.mid_range" title="cf.Data.mid_range"><tt class="xref py py-obj docutils literal"><span class="pre">mid_range</span></tt></a>, <a class="reference internal" href="cf.Data.range.html#cf.Data.range" title="cf.Data.range"><tt class="xref py py-obj docutils literal"><span class="pre">range</span></tt></a>,
    83. 

  83. <a class="reference internal" href="cf.Data.sample_size.html#cf.Data.sample_size" title="cf.Data.sample_size"><tt class="xref py py-obj docutils literal"><span class="pre">sample_size</span></tt></a>, <a class="reference internal" href="cf.Data.sd.html#cf.Data.sd" title="cf.Data.sd"><tt class="xref py py-obj docutils literal"><span class="pre">sd</span></tt></a>, <a class="reference internal" href="cf.Data.sum_of_weights.html#cf.Data.sum_of_weights" title="cf.Data.sum_of_weights"><tt class="xref py py-obj docutils literal"><span class="pre">sum_of_weights</span></tt></a>, <a class="reference internal" href="cf.Data.sum_of_weights2.html#cf.Data.sum_of_weights2" title="cf.Data.sum_of_weights2"><tt class="xref py py-obj docutils literal"><span class="pre">sum_of_weights2</span></tt></a>,
    84. 

  84. <a class="reference internal" href="cf.Data.var.html#cf.Data.var" title="cf.Data.var"><tt class="xref py py-obj docutils literal"><span class="pre">var</span></tt></a></p>
    85. 

  85. </div>
    86. 

  86. <table class="docutils field-list" frame="void" rules="none">
    87. 

  87. <col class="field-name" />
    88. 

  88. <col class="field-body" />
    89. 

  89. <tbody valign="top">
    90. 

  90. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first">axes : (sequence of) int, optional</p>
    91. 

  91. <p>squeeze : bool, optional</p>
    92. 

  92. <dl class="docutils">
    93. 

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

  94. <dd><p class="first last">If True then update the data array in place. By default a new
    95. 

  95. data array is created.</p>
    96. 

  96. </dd>
    97. 

  97. </dl>
    98. 

  98. </td>
    99. 

  99. </tr>
    100. 

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

  101. <dt>out <span class="classifier-delimiter">:</span> <span class="classifier">cf.Data</span></dt>
    102. 

  102. <dd><p class="first last">The collapsed array.</p>
    103. 

  103. </dd>
    104. 

  104. </dl>
    105. 

  105. </td>
    106. 

  106. </tr>
    107. 

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

  108. </tr>
    109. 

  109. </tbody>
    110. 

  110. </table>
    111. 

  111. </dd></dl>
    112. 

  112. 

  113. </div>
    114. 

  114. 

  115. 

  116.           </div>
    117. 

  117.         </div>
    118. 

  118.       </div>
    119. 

  119.       <div class="sphinxsidebar">
    120. 

  120.         <div class="sphinxsidebarwrapper">
    121. 

  121.   <h4>Previous topic</h4>
    122. 

  122.   <p class="topless"><a href="cf.Data.squeeze.html"
    123. 

  123.                         title="previous chapter">cf.Data.squeeze</a></p>
    124. 

  124.   <h4>Next topic</h4>
    125. 

  125.   <p class="topless"><a href="cf.Data.sum_of_weights.html"
    126. 

  126.                         title="next chapter">cf.Data.sum_of_weights</a></p>
    127. 

  127.   <h3>This Page</h3>
    128. 

  128.   <ul class="this-page-menu">
    129. 

  129.     <li><a href="../_sources/generated/cf.Data.sum.txt"
    130. 

  130.            rel="nofollow">Show Source</a></li>
    131. 

  131.   </ul>
    132. 

  132. <div id="searchbox" style="display: none">
    133. 

  133.   <h3>Quick search</h3>
    134. 

  134.     <form class="search" action="../search.html" method="get">
    135. 

  135.       <input type="text" name="q" />
    136. 

  136.       <input type="submit" value="Go" />
    137. 

  137.       <input type="hidden" name="check_keywords" value="yes" />
    138. 

  138.       <input type="hidden" name="area" value="default" />
    139. 

  139.     </form>
    140. 

  140.     <p class="searchtip" style="font-size: 90%">
    141. 

  141.     Enter search terms or a module, class or function name.
    142. 

  142.     </p>
    143. 

  143. </div>
    144. 

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

  145.         </div>
    146. 

  146.       </div>
    147. 

  147.       <div class="clearer"></div>
    148. 

  148.     </div>
    149. 

  149.     <div class="related">
    150. 

  150.       <h3>Navigation</h3>
    151. 

  151.       <ul>
    152. 

  152.         <li class="right" style="margin-right: 10px">
    153. 

  153.           <a href="../genindex.html" title="General Index"
    154. 

  154.              >index</a></li>
    155. 

  155.         <li class="right" >
    156. 

  156.           <a href="cf.Data.sum_of_weights.html" title="cf.Data.sum_of_weights"
    157. 

  157.              >next</a> |</li>
    158. 

  158.         <li class="right" >
    159. 

  159.           <a href="cf.Data.squeeze.html" title="cf.Data.squeeze"
    160. 

  160.              >previous</a> |</li>
    161. 

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

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

  163. 

  164.       <option value="../../1.0/index.html"selected>1.0
    165. 

  165. 

  166.       <option value="../../0.9.9/index.html">0.9.9
    167. 

  167. 

  168.       <option value="../../0.9.8.3/index.html">0.9.8.3
    169. 

  169. 

  170.       <option value="../../archive.html">Archive
    171. 

  171. 

  172.       </select>
    173. 

  173.   </li>
    174. 

  174.   
    175. 

  175.         <li><a href="../index.html">Documentation</a> &raquo;</li>
    176. 

  176. 

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

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

  179.           <li><a href="../classes/cf.Data.html" >cf.Data</a> &raquo;</li> 
    180. 

  180.       </ul>
    181. 

  181.     </div>
    182. 

  182.     <div class="footer">
    183. 

  183.         &copy; Copyright 2015, David Hassell.
    184. 

  184.       Last updated on May 27, 2015.
    185. 

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

  186.     </div>
    187. 

  187.   </body>
    188. 

  188. </html>
    189.