DataSet

java.lang.Object
- graph.DataSet

Direct Known Subclasses:

VectorSet
```
public class DataSet
extends Object
```
This class is designed to hold the data to be plotted. It is to be used in conjunction with the Graph2D class and Axis class for plotting 2D graphs.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`clipping` Boolean to control clipping of the data window.
`Graph2D`	`g2d` The Graphics canvas that is driving the whole show.
`static int`	`LINE` A constant value flag used to specify that a straight line segment is to join the data points.
`Color`	`linecolor` The color of the straight line segments
`int`	`linestyle` The linestyle to employ when joining the data points with straight line segments.
`int`	`marker` The index of the marker to use at the data points.
`Color`	`markercolor` The marker color
`double`	`markerscale` The scaling factor for the marker.
`static int`	`NOLINE` A constant value flag used to specify no straight line segment is to join the data points
`Axis`	`xaxis` The Axis object the X data is attached to.
`double`	`xmax` The current plottable X maximum of the data.
`double`	`xmin` The current plottable X minimum of the data.
`Axis`	`yaxis` The Axis object the Y data is attached to.
`double`	`ymax` The current plottable Y maximum of the data.
`double`	`ymin` The current plottable Y minimum of the data.

Constructor Summary

Constructors
Constructor and Description
`DataSet()` Instantiate an empty data set.
`DataSet(double[] d, int n)` Instantiate a DataSet with the parsed data.
`DataSet(double[] d, int n, int s)` Instantiate a DataSet with the parsed data.
`DataSet(int stride)` Instantiate an empty data set.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`append(double[] d, int n)` Append data to the data set.
`int`	`dataPoints()` Return the number of data points in the DataSet
`void`	`delete(int start, int end)` Delete data from the data set (start and end are inclusive).
`void`	`deleteData()` Delete all the data from the data set.
`void`	`draw_data(Graphics g, Rectangle bounds)` Draw the straight line segments and/or the markers at the data points.
`double[]`	`getClosestPoint(double x, double y)` Return the data point that is closest to the parsed (x,y) position
`double[]`	`getPoint(int index)` get the data point at the parsed index.
`double`	`getXmax()` return the data X maximum.
`double`	`getXmin()` return the data X minimum.
`double`	`getYmax()` return the data Y maximum.
`double`	`getYmin()` return the data Y minimum.
`void`	`legend(double x, double y, String text)` Define a data legend in the graph window
`void`	`legend(int x, int y, String text)` Define a data legend in the graph window
`void`	`legendColor(Color c)` Set the color for the legend text
`void`	`legendFont(Font f)` Set the font to be used in the legend

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NOLINE
```
public static final int NOLINE
```
    A constant value flag used to specify no straight line segment is to join the data points
    
    See Also:
    
    Constant Field Values
  - LINE
```
public static final int LINE
```
    A constant value flag used to specify that a straight line segment is to join the data points.
    
    See Also:
    
    Constant Field Values
  - g2d
```
public Graph2D g2d
```
    The Graphics canvas that is driving the whole show.
    
    See Also:
    
    Graph2D
  - linestyle
```
public int linestyle
```
    The linestyle to employ when joining the data points with straight line segments. Currently only solid and no line are supported.
  - linecolor
```
public Color linecolor
```
    The color of the straight line segments
  - marker
```
public int marker
```
    The index of the marker to use at the data points.
    
    See Also:
    
    Markers
  - markercolor
```
public Color markercolor
```
    The marker color
  - markerscale
```
public double markerscale
```
    The scaling factor for the marker. Default value is 1.
  - xaxis
```
public Axis xaxis
```
    The Axis object the X data is attached to. From the Axis object the scaling for the data can be derived.
    
    See Also:
    
    Axis
  - yaxis
```
public Axis yaxis
```
    The Axis object the Y data is attached to.
    
    See Also:
    
    Axis
  - xmax
```
public double xmax
```
    The current plottable X maximum of the data. This can be very different from true data X maximum. The data is clipped when plotted.
  - xmin
```
public double xmin
```
    The current plottable X minimum of the data. This can be very different from true data X minimum. The data is clipped when plotted.
  - ymax
```
public double ymax
```
    The current plottable Y maximum of the data. This can be very different from true data Y maximum. The data is clipped when plotted.
  - ymin
```
public double ymin
```
    The current plottable Y minimum of the data. This can be very different from true data Y minimum. The data is clipped when plotted.
  - clipping
```
public boolean clipping
```
    Boolean to control clipping of the data window. Default value is true, clip the data window.
- Constructor Detail
  - DataSet
```
public DataSet()
```
    Instantiate an empty data set.
  - DataSet
```
public DataSet(int stride)
        throws Exception
```
    Instantiate an empty data set.
    
    Parameters:
    
    stride - the stride of the data set. The default stride is 2.
    
    Throws:
    
    Exception
  - DataSet
```
public DataSet(double[] d,
               int n)
        throws Exception
```
    Instantiate a DataSet with the parsed data. Default stride is 2. The double array contains the data. The X data is expected in the even indices, the y data in the odd. The integer n is the number of data Points. This means that the length of the data array is 2*n.
    
    Parameters:
    
    d - Array containing the (x,y) data pairs.
    
    n - Number of (x,y) data pairs in the array.
    
    Throws:
    
    Exception - A Generic exception if it fails to load the parsed array into the class.
  - DataSet
```
public DataSet(double[] d,
               int n,
               int s)
        throws Exception
```
    Instantiate a DataSet with the parsed data. The double array contains the data. The X data is expected to be in indices i*stride where i=0,1,... The Y data is expected to be found in indices i*stride+1 where i=0,1,2... The integer n is the number of data Points. This means that the length of the data array is 2*stride.
    
    Parameters:
    
    d - Array containing the (x,y) data pairs.
    
    n - Number of (x,y) data pairs in the array.
    
    s - The stride of the data.
    
    Throws:
    
    Exception - A Generic exception if it fails to load the parsed array into the class.
- Method Detail
  - append
```
public void append(double[] d,
                   int n)
            throws Exception
```
    Append data to the data set.
    
    Parameters:
    
    d - Array containing (x,y) pairs to append
    
    n - Number of (x,y) data pairs in the array.
    
    Throws:
    
    Exception - A generic exception if it fails to load the parsed array into the class.
  - delete
```
public void delete(int start,
                   int end)
```
    Delete data from the data set (start and end are inclusive). The first (x,y) pair in the data set start at index 0.
    
    Parameters:
    
    start - The start (x,y) pair index.
    
    end - The end (x,y) pair index.
  - deleteData
```
public void deleteData()
```
    Delete all the data from the data set.
  - draw_data
```
public void draw_data(Graphics g,
                      Rectangle bounds)
```
    Draw the straight line segments and/or the markers at the data points. If this data has been attached to an Axis then scale the data based on the axis maximum/minimum otherwise scale using the data's maximum/minimum
    
    Parameters:
    
    g - Graphics state
    
    bounds - The data window to draw into
  - getXmax
```
public double getXmax()
```
    return the data X maximum.
  - getXmin
```
public double getXmin()
```
    return the data X minimum.
  - getYmax
```
public double getYmax()
```
    return the data Y maximum.
  - getYmin
```
public double getYmin()
```
    return the data Y minimum.
  - legend
```
public void legend(int x,
                   int y,
                   String text)
```
    Define a data legend in the graph window
    
    Parameters:
    
    x - pixel position of the legend.
    
    y - pixel position of the legend.
    
    text - text to display in the legend
  - legend
```
public void legend(double x,
                   double y,
                   String text)
```
    Define a data legend in the graph window
    
    Parameters:
    
    x - data position of the legend.
    
    y - data position of the legend.
    
    text - text to display in the legend
  - legendFont
```
public void legendFont(Font f)
```
    Set the font to be used in the legend
    
    Parameters:
    
    f - font
  - legendColor
```
public void legendColor(Color c)
```
    Set the color for the legend text
    
    Parameters:
    
    c - color
  - dataPoints
```
public int dataPoints()
```
    Return the number of data points in the DataSet
    
    Returns:
    
    number of (x,y0 points.
  - getPoint
```
public double[] getPoint(int index)
```
    get the data point at the parsed index. The first (x,y) pair is at index 0.
    
    Parameters:
    
    index - Data point index
    
    Returns:
    
    array containing the (x,y) pair.
  - getClosestPoint
```
public double[] getClosestPoint(double x,
                                double y)
```
    Return the data point that is closest to the parsed (x,y) position
    
    Parameters:
    
    x -
    
    y - (x,y) position in data space.
    
    Returns:
    
    array containing the closest data point.

Class DataSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NOLINE

LINE

g2d

linestyle

linecolor

marker

markercolor

markerscale

xaxis

yaxis

xmax

xmin

ymax

ymin

clipping

Constructor Detail

DataSet

DataSet

DataSet

DataSet

Method Detail

append

delete

deleteData

draw_data

getXmax

getXmin

getYmax

getYmin

legend

legend

legendFont

legendColor

dataPoints

getPoint

getClosestPoint