
HistogramPlotter |
ptolemy.actor.lib.gui.HistogramPlotter |
A histogram plotter. This plotter contains an instance of the Histogram
class from the Ptolemy plot package as a public member. A histogram
of data at the input port, which can consist of any number of channels,
is plotted on this instance. The input data type is double.
The output plot consists of a set of vertical bars, each representing
a histogram bin. The height of the bar is the count of the number
of inputs that have been observed that fall within that bin.
The n-th bin represents values in the range
(x - w/2 + o, x + w/2 + o),
where w is the value of the binWidth parameter,
and o is the value of the binOffset parameter.
So for example, if o = w/2,
then each bin represents values from nw to
(n + 1)w for some integer n.
The default offset is 0.5, half the default bin width, which is 1.0.
This actor has a legend parameter,
which gives a comma-separated list of labels to attach to
each dataset. Normally, the number of elements in this list
should equal the number of input channels, although this
is not enforced.
Author(s): Edward A. Lee
Version:$Id: HistogramPlotter.java,v 1.53 2005/07/08 19:56:19 cxh Exp $
Pt.Proposed Rating:Green (eal)
Pt.Accepted Rating:Green (cxh)
input
The input port, which is a multiport.
binWidth
The width of the bin of the histogram.
This parameter has type double, with default value 1.0.
binOffset
The offset for bins of the histogram.
This parameter has type double, with default value 0.5.