org.math.plot.Plot2DPanel

org.math.plot.Plot2DPanel Class Reference

Inheritance diagram for org.math.plot.Plot2DPanel:

org.math.plot.PlotPanel List of all members.

Detailed Description

Class suitable for plotting 2D data on a panel, to be added to a swing container.

Class for ascending compatibility

Author:
Yann Richet

Definition at line 21 of file Plot2DPanel.java.

Public Member Functions

 Plot2DPanel ()
 Plot2DPanel (double[] min, double[] max, String[] axesScales, String[] axesLabels)
 Plot2DPanel (PlotCanvas _canvas, String legendOrientation)
 Plot2DPanel (PlotCanvas _canvas)
 Plot2DPanel (String legendOrientation)
int addScatterPlot (String name, Color color, double[][] XY)
int addScatterPlot (String name, Color color, double[] Y)
int addScatterPlot (String name, Color color, double[] X, double[] Y)
int addScatterPlot (String name, double[][] XY)
int addScatterPlot (String name, double[] Y)
int addScatterPlot (String name, double[] X, double[] Y)
int addLinePlot (String name, Color color, double[][] XY)
int addLinePlot (String name, Color color, double[] Y)
int addLinePlot (String name, Color color, double[] X, double[] Y)
int addLinePlot (String name, double[][] XY)
int addLinePlot (String name, double[] Y)
int addLinePlot (String name, double[] X, double[] Y)
int addBarPlot (String name, Color color, double[][] XY)
int addBarPlot (String name, Color color, double[] Y)
int addBarPlot (String name, Color color, double[] X, double[] Y)
int addBarPlot (String name, double[][] XY)
int addBarPlot (String name, double[] Y)
int addBarPlot (String name, double[] X, double[] Y)
int addStaircasePlot (String name, Color color, double[][] XY)
int addStaircasePlot (String name, Color color, double[] Y)
int addStaircasePlot (String name, Color color, double[] X, double[] Y)
int addStaircasePlot (String name, double[][] XY)
int addStaircasePlot (String name, double[] Y)
int addStaircasePlot (String name, double[] X, double[] Y)
int addBoxPlot (String name, Color color, double[][] XY, double[][] dXdY)
int addBoxPlot (String name, double[][] XY, double[][] dXdY)
int addBoxPlot (String name, Color color, double[][] XYdXdY)
int addBoxPlot (String name, double[][] XYdXdY)
int addHistogramPlot (String name, Color color, double[][] XY, double[] dX)
int addHistogramPlot (String name, double[][] XY, double[] dX)
int addHistogramPlot (String name, Color color, double[][] XYdX)
int addHistogramPlot (String name, double[][] XYdX)
int addHistogramPlot (String name, Color color, double[] sample, int n)
int addHistogramPlot (String name, double[] X, int n)
int addHistogramPlot (String name, Color color, double[] sample, double...bounds)
int addHistogramPlot (String name, double[] X, double...bounds)
int addHistogramPlot (String name, Color color, double[] X, double min, double max, int n)
int addHistogramPlot (String name, double[] X, double min, double max, int n)
int addCloudPlot (String name, Color color, double[][] sampleXY, int nX, int nY)
int addCloudPlot (String name, double[][] sampleXY, int nX, int nY)
Override int addPlot (String type, String name, Color color, double[]...XY)

Constructor & Destructor Documentation

org.math.plot.Plot2DPanel.Plot2DPanel (  ) 

Constructor for Plot2DPanel. Create a new blank instance of Plot2DPanel, to be added to a swing component.

Definition at line 30 of file Plot2DPanel.java.

00030                          {
00031         super(new Plot2DCanvas());
00032     }

Member Function Documentation

int org.math.plot.Plot2DPanel.addScatterPlot ( String  name,
Color  color,
double  XY[][] 
)

Adds a scatter plot (each data point is plotted as a single dot marker) to the current plot panel.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY Pairs of array of double. First one contains the X position of the data points, second contains Y position.
Each array of the pair must be of the same length; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Each data set must come in pair of array of double; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Returns:
the index of the plot in the panel (int).
See also:
addLinePlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addBoxPlot(String, Color, double[][], double[][])

addHistogramPlot(String, Color, double[][], double[])

addStaircasePlot(String, Color, double[]...)

Definition at line 73 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addPlot(), org.math.plot.Plot2DPanel.addScatterPlot(), org.math.plot.plots.VectorLayerPlot.main(), org.math.plot.plots.ScatterPlot.main(), org.math.plot.plots.QuantileLayerPlot.main(), org.math.plot.plots.GaussianDensityLayerPlot.main(), org.math.plot.plots.DensityLayerPlot.main(), org.math.plot.PlotPanel.main(), and org.math.plot.plotObjects.RasterImage.main().

00073                                                                        {
00074         return ((Plot2DCanvas) plotCanvas).addScatterPlot(name, color, XY);
00075     }

int org.math.plot.Plot2DPanel.addLinePlot ( String  name,
Color  color,
double  XY[][] 
)

Adds a line plot (each data point is connected to the next one by a solid line) to the current plot panel.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY Pairs of array of double. First one contains the X position of the data points, second contains Y position.
Each array of the pair must be of the same length; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Each data set must come in pair of array of double; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addBoxPlot(String, Color, double[]... )

addHistogramPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

Definition at line 120 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addLinePlot(), org.math.plot.Plot2DPanel.addPlot(), org.math.plot.plots.LinePlot.main(), and org.math.plot.PlotPanel.main().

00120                                                                     {
00121         return ((Plot2DCanvas) plotCanvas).addLinePlot(name, color, XY);
00122     }

int org.math.plot.Plot2DPanel.addBarPlot ( String  name,
Color  color,
double  XY[][] 
)

Adds a bar plot (each data point is shown as a dot marker connected to the horizontal axis by a vertical line) to the current plot panel.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY Pairs of array of double. First one contains the X position of the data points, second contains Y position.
Each array of the pair must be of the same length; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Each data set must come in pair of array of double; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addLinePlot(String, Color, double[]...)

addBoxPlot(String, Color, double[]... )

addHistogramPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

Definition at line 167 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addBarPlot(), org.math.plot.Plot2DPanel.addPlot(), org.math.plot.plots.BarPlot.main(), and org.math.plot.PlotPanel.main().

00167                                                                    {
00168         return ((Plot2DCanvas) plotCanvas).addBarPlot(name, color, XY);
00169     }

int org.math.plot.Plot2DPanel.addStaircasePlot ( String  name,
Color  color,
double  XY[][] 
)

Adds a staircase plot (each data point is connected to the following one by a horizontal line then a vertical line) to the current plot panel.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY Pairs of array of double. First one contains the X position of the data points, second contains Y position.
Each array of the pair must be of the same length; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Each data set must come in pair of array of double; if not a ArrayIndexOutOfBoundsException exception will be thrown.
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addBoxPlot(String, Color, double[][], double[][])

addHistogramPlot(String, Color, double[][], double[])

addLinePlot(String, Color, double[]...)

Definition at line 214 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addPlot(), org.math.plot.Plot2DPanel.addStaircasePlot(), and org.math.plot.plots.StaircasePlot.main().

00214                                                                          {
00215         return ((Plot2DCanvas) plotCanvas).addStaircasePlot(name, color, XY);
00216     }

int org.math.plot.Plot2DPanel.addBoxPlot ( String  name,
Color  color,
double  XY[][],
double  dXdY[][] 
)

Adds a box plot to the current plot panel. Each data point is plotted as a dot marker at the center of a rectangle.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY m*2 array of array of double. Contains the x,y coordinates of the m boxes' center (m lines, 2 rows).
dXdY m*2 array of array of double. Contains the width and heigth of the m boxes (m lines, 2 rows).
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

addHistogramPlot(String, Color, double[][], double[])

addLinePlot(String, Color, double[]...)

Definition at line 255 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addBoxPlot(), and org.math.plot.Plot2DPanel.addPlot().

00255                                                                                     {
00256         return ((Plot2DCanvas) plotCanvas).addBoxPlot(name, color, XY, dXdY);
00257     }

int org.math.plot.Plot2DPanel.addBoxPlot ( String  name,
Color  color,
double  XYdXdY[][] 
)

Adds a box plot to the current plot panel. Each data point is plotted as a dot marker at the center of a rectangle.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XYdXdY m*4 array of array of double. Contains the x,y coordinates of the m boxes' center and the boxes width and heigth (m lines, 4 rows).
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

addHistogramPlot(String, Color, double[][], double[])

addLinePlot(String, Color, double[]...)

Definition at line 278 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

00278                                                                        {
00279         return ((Plot2DCanvas) plotCanvas).addBoxPlot(name, color, XYdXdY);
00280     }

int org.math.plot.Plot2DPanel.addHistogramPlot ( String  name,
Color  color,
double  XY[][],
double[]  dX 
)

Adds a histogram plot to the current plot panel. Each data point is as vertical bar which width can be set.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
XY m*2 array of array of double. Contains the x coordinate and the heigth of each bar (m lines, 2 rows).
dX Array of double. Contains the width each bar (m lines).
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

addBoxPlot(String, Color, double[][])

addLinePlot(String, Color, double[]...)

Definition at line 302 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

Referenced by org.math.plot.Plot2DPanel.addHistogramPlot(), org.math.plot.Plot2DPanel.addPlot(), and org.math.plot.plots.HistogramPlot2D.main().

00302                                                                                       {
00303         return ((Plot2DCanvas) plotCanvas).addHistogramPlot(name, color, XY, dX);
00304     }

int org.math.plot.Plot2DPanel.addHistogramPlot ( String  name,
double  XYdX[][] 
)

Adds a histogram plot to the current plot panel. Each data point is as vertical bar which width can be set.

Parameters:
name Name for the plot, which will be used in the legend. (String)
XYdX m*3 array of array of double. Contains the x coordinate, the heigth of each bar and the width of each bar (m lines, 3 rows).
Returns:
the index of the plot in the panel (int).
See also:
addScatterPlot(String,Color,double[]...)

addBarPlot(String, Color, double[]...)

addStaircasePlot(String, Color, double[]...)

addBoxPlot(String, Color, double[][])

addLinePlot(String, Color, double[]...)

Definition at line 328 of file Plot2DPanel.java.

References org.math.plot.Plot2DPanel.addHistogramPlot(), and org.math.plot.PlotPanel.getNewColor().

00328                                                               {
00329         return addHistogramPlot(name, getNewColor(), XYdX);
00330     }

int org.math.plot.Plot2DPanel.addHistogramPlot ( String  name,
Color  color,
double[]  sample,
int  n 
)

Adds a plot of the statistical repartition of a sample, as a histogram.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
sample Array of double containing the data which statistics will be plotted.
n Bin number for the statistics (int).
Returns:
the index of the plot in the panel (int).

Definition at line 341 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

00341                                                                                   {
00342         return ((Plot2DCanvas) plotCanvas).addHistogramPlot(name, color, sample, n);
00343     }

int org.math.plot.Plot2DPanel.addHistogramPlot ( String  name,
Color  color,
double[]  sample,
double...  bounds 
)

Adds a plot of the statistical repartition of a sample, as a histogram. The bins' limits can be set.

Parameters:
name Name for the plot, which will be used in the legend. (String)
color Plot color. (Color)
sample Array of double containing the data which statistics will be plotted.
bounds Specify the limits for the bins' boundaries.
Returns:
the index of the plot in the panel (int).

Definition at line 359 of file Plot2DPanel.java.

References org.math.plot.PlotPanel.plotCanvas.

00359                                                                                              {
00360         return ((Plot2DCanvas) plotCanvas).addHistogramPlot(name, color, sample, bounds);
00361     }

The documentation for this class was generated from the following file:
Generated on Wed Sep 5 21:44:02 2007 for jmathplot by  doxygen 1.5.1