<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Scientific.Statistics.Histogram.WeightedHistogram</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Scientific-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Scientific-module.html">Package Scientific</a> ::
<a href="Scientific.Statistics-module.html">Package Statistics</a> ::
<a href="Scientific.Statistics.Histogram-module.html">Module Histogram</a> ::
Class WeightedHistogram
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Scientific.Statistics.Histogram.WeightedHistogram-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class WeightedHistogram</h1><p class="nomargin-top"></p>
<pre class="base-tree">
<a href="Scientific.Statistics.Histogram.Histogram-class.html">Histogram</a> --+
|
<strong class="uidshort">WeightedHistogram</strong>
</pre>
<hr />
<p>Weighted histogram in one variable</p>
<p>Constructor: WeightedHistogram(|data|, |weights|, |bins|,
|range|=None)</p>
<p>Arguments:</p>
<p>In a weighted histogram, each point has a specific weight. If all
weights are one, the result is equivalent to a standard histogram. The
bin index and the number of points in a bin can be obtained by indexing
the histogram with the bin number. Application of len() yields the number
of bins. A histogram thus behaves like a sequence of bin index - bin
count pairs.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.Statistics.Histogram.WeightedHistogram-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>,
<span class="summary-sig-arg">weights</span>,
<span class="summary-sig-arg">nbins</span>,
<span class="summary-sig-arg">range</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Scientific.Statistics.Histogram.WeightedHistogram-class.html#addData" class="summary-sig-name">addData</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">data</span>,
<span class="summary-sig-arg">weights</span>)</span><br />
Add values to the originally supplied data sequence.</td>
<td align="right" valign="top">
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="Scientific.Statistics.Histogram.Histogram-class.html">Histogram</a></code></b>:
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#__getitem__">__getitem__</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#__getslice__">__getslice__</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#__len__">__len__</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#getBinCounts">getBinCounts</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#getBinIndices">getBinIndices</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#normalize">normalize</a></code>,
<code><a href="Scientific.Statistics.Histogram.Histogram-class.html#normalizeArea">normalizeArea</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">data</span>,
<span class="sig-arg">weights</span>,
<span class="sig-arg">nbins</span>,
<span class="sig-arg">range</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>data</code></strong> (<code>Numeric.array</code>) - a sequence of data points</li>
<li><strong class="pname"><code>weights</code></strong> (<code>Numeric.array</code>) - a sequence of weights, same length as data</li>
<li><strong class="pname"><code>nbins</code></strong> (<code>int</code>) - the number of bins into which the data is to be sorted</li>
<li><strong class="pname"><code>range</code></strong> (<code>tuple</code> or <code>NoneType</code>) - a tuple of two values, specifying the lower and the upper end of
the interval spanned by the bins. Any data point outside this
interval will be ignored. If no range is given, the smallest and
largest data values are used to define the interval.</li>
</ul></dd>
<dt>Overrides:
<a href="Scientific.Statistics.Histogram.Histogram-class.html#__init__">Histogram.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="addData"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addData</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">data</span>,
<span class="sig-arg">weights</span>)</span>
</h3>
</td><td align="right" valign="top"
>
</td>
</tr></table>
<p>Add values to the originally supplied data sequence. Use this method
to feed long data sequences in multiple parts to avoid memory
shortages.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>data</code></strong> (<code>Numeric.array</code>) - a sequence of data points</li>
</ul></dd>
<dt>Overrides:
<a href="Scientific.Statistics.Histogram.Histogram-class.html#addData">Histogram.addData</a>
</dt>
</dl>
<div class="fields"> <p><strong>Note:</strong>
this does not affect the default range of the histogram, which is
fixed when the histogram is created.
</p>
</div></td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Scientific-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://dirac.cnrs-orleans.fr/ScientificPython/">Scientific Python</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Thu Dec 4 08:05:47 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
