org.simbrain.plot.histogram

Class HistogramModel

java.lang.Object

org.simbrain.plot.ChartModel

org.simbrain.plot.histogram.HistogramModel

public class HistogramModel
extends ChartModel

Underlying model for the histogram data, in the form of a list of double arrays, one array per histogram. The histograms are represented by different colors in HistogramPanel. The JFreeChart dataset is also stored here.

Author:

Zach Tosi, Jeff Yoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BINS The default number of bins.
static int	INITIAL_DATA_SOURCES Default number of data sources for plot initialization.

Constructor Summary

Constructors

Constructor and Description
HistogramModel() Creates a blank histogram.
HistogramModel(int numSources) Creates a histogram with no data and a specified number of datsets.
HistogramModel(int numSources, int bins)
HistogramModel(java.util.List<double[]> data, java.util.List<java.lang.String> dataNames, int bins) Creates a histogram with the provided number of bins, data set(s), and data name(s), but does not include titles for the histogram, the x axis or the y axis.
HistogramModel(java.util.List<double[]> data, java.util.List<java.lang.String> dataNames, int bins, java.lang.String title, java.lang.String xAxisName, java.lang.String yAxisName) Creates a histogram with the provided number of bins, data set(s), data name(s), title, and x and y axis titles.
HistogramModel(java.util.List<double[]> newData, java.util.List<java.lang.String> dataNames, int bins, java.lang.String title, java.lang.String xAxisName, java.lang.String yAxisName, java.awt.Color[] colorPallet) Creates a histogram with the provided number of bins, data set(s), data name(s), title, and x and y axis titles.

Method Summary

Modifier and Type	Method and Description
void	addData(double[] histData, java.lang.Integer index) Add double array data to a specified data series.
void	addDataSource() Adds a data source to the chart.
void	addDataSources(int numDataSources) Create specified number of set of data sources.
int	getBins()
java.util.List<double[]>	getData()
java.util.List<java.lang.String>	getDataNames()
org.jfree.data.xy.IntervalXYDataset	getDataSet()
java.util.Collection<OverwritableHistogramDataset.ColoredDataSeries>	getSeriesData() Return the underlying series data.
void	redraw() Re-add the data.
void	resetData() Clears the data.
void	resetData(java.util.List<double[]> data, java.util.List<java.lang.String> names) Reset the data in the model.
void	setBins(int bins) Sets the number of bins.
void	setSeriesColor(java.lang.String name, java.awt.Color c) Set the color of a data series.

Methods inherited from class org.simbrain.plot.ChartModel

addChartSettingsListener, addListener, fireChartInitialized, fireDataSourceAdded, fireDataSourceRemoved, fireSettingsChanged, getXStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_BINS

public static final int DEFAULT_BINS

The default number of bins.

See Also:

Constant Field Values

INITIAL_DATA_SOURCES

public static final int INITIAL_DATA_SOURCES

Default number of data sources for plot initialization.

See Also:

Constant Field Values

Constructor Detail

HistogramModel

public HistogramModel()

Creates a blank histogram. Used in de-serializing.

HistogramModel

public HistogramModel(int numSources)

Creates a histogram with no data and a specified number of datsets.

Parameters:

numSources - number of datasets to add

HistogramModel

public HistogramModel(int numSources,
                      int bins)

HistogramModel

public HistogramModel(java.util.List<double[]> data,
                      java.util.List<java.lang.String> dataNames,
                      int bins)

Creates a histogram with the provided number of bins, data set(s), and data name(s), but does not include titles for the histogram, the x axis or the y axis.

Parameters:

data - the data set(s) to be plotted

dataNames - the name(s) of the data set(s)

bins - the number of bins used in the histogram

HistogramModel

public HistogramModel(java.util.List<double[]> data,
                      java.util.List<java.lang.String> dataNames,
                      int bins,
                      java.lang.String title,
                      java.lang.String xAxisName,
                      java.lang.String yAxisName)

Creates a histogram with the provided number of bins, data set(s), data name(s), title, and x and y axis titles.

Parameters:

data - the data set(s) to be plotted

dataNames - the name(s) of the data set(s)

bins - the number of bins used in the histogram

title - the title of the histogram

xAxisName - the title of the x axis

yAxisName - the title of the y axis

HistogramModel

public HistogramModel(java.util.List<double[]> newData,
                      java.util.List<java.lang.String> dataNames,
                      int bins,
                      java.lang.String title,
                      java.lang.String xAxisName,
                      java.lang.String yAxisName,
                      java.awt.Color[] colorPallet)

Creates a histogram with the provided number of bins, data set(s), data name(s), title, and x and y axis titles.

Parameters:

newData - the data set(s) to be plotted

dataNames - the name(s) of the data set(s)

bins - the number of bins used in the histogram

title - the title of the histogram

xAxisName - the title of the x axis

yAxisName - the title of the y axis

colorPallet - a custom color pallete

Method Detail

addData

public void addData(double[] histData,
                    java.lang.Integer index)

Add double array data to a specified data series. This is the main method used to dynamically add data when the histogram is used as a plot component. Called via reflection from HistogramComponent.

Parameters:

index - data index

histData - the data to add at that index

redraw

public void redraw()

Re-add the data.

resetData

public void resetData(java.util.List<double[]> data,
                      java.util.List<java.lang.String> names)

Reset the data in the model.

Parameters:

data - the data to set

names -

resetData

public void resetData()

Clears the data. Currently just adds a single vector to each data source.

addDataSources

public void addDataSources(int numDataSources)

Create specified number of set of data sources. Adds these two existing data sources.

Parameters:

numDataSources - number of data sources to initialize plot with

addDataSource

public void addDataSource()

Adds a data source to the chart.

setBins

public void setBins(int bins)

Sets the number of bins. Also automatically updates the number of bins text field, but does NOT redraw the histogram.

Parameters:

bins - the new number of bins

getData

public java.util.List<double[]> getData()

Returns:

the data

setSeriesColor

public void setSeriesColor(java.lang.String name,
                           java.awt.Color c)

Set the color of a data series.

Parameters:

name - name of series

c - the color to set

getSeriesData

public java.util.Collection<OverwritableHistogramDataset.ColoredDataSeries> getSeriesData()

Return the underlying series data.

Returns:

the data

getDataNames

public java.util.List<java.lang.String> getDataNames()

Returns:

the dataNames

getBins

public int getBins()

Returns:

the bins

getDataSet

public org.jfree.data.xy.IntervalXYDataset getDataSet()

Returns:

the dataSet