VectorSet

java.lang.Object
- graph.DataSet
- - graph.VectorSet

```
public class VectorSet
extends DataSet
```
This class is designed to hold vectors to be plotted. It extends the DataSet class. The vectors are defined as (x,y,dx,dy) where (x,y) is the position of the vector tail and (dx,dy) is the relative position of the head. 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
`static int`	`MAXIMUM` A constant value flag used to specify if the max magnitude of the vectors is going to be used as the scaling variable
`static int`	`MEAN` A constant value flag used to specify if the mean magnitude of the vectors is going to be used as the scaling variable
`static int`	`MINIMUM` A constant value flag used to specify if the minimum magnitude of the vectors is going to be used as the scaling variable
`double`	`scale` This is the scaling to be used when drawing vectors.

Fields inherited from class graph.DataSet
clipping, g2d, LINE, linecolor, linestyle, marker, markercolor, markerscale, NOLINE, xaxis, xmax, xmin, yaxis, ymax, ymin

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw_data(Graphics g, Rectangle bounds)` Draw the vectors at the data points.
`double`	`getScaleFactor()` return the current scaling factor.
`void`	`legend()` Draw a Vector legend in the graph window.
`void`	`legend(double x, double y, String text)` Define a Vector legend in the graph window
`void`	`legend(int x, int y, String text)` Define a Vector legend in the graph window
`void`	`legend(String text)` Define a Vector legend in the graph window.
`void`	`setScale(double scale)` Set the scaling to use when drawing vectors
`void`	`setScalingType(int type)` Set the scaling type to use when drawing vectors

Methods inherited from class graph.DataSet
append, dataPoints, delete, deleteData, getClosestPoint, getPoint, getXmax, getXmin, getYmax, getYmin, legendColor, legendFont

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

- Field Detail
  - MEAN
```
public static final int MEAN
```
    A constant value flag used to specify if the mean magnitude of the vectors is going to be used as the scaling variable
    
    See Also:
    
    Constant Field Values
  - MINIMUM
```
public static final int MINIMUM
```
    A constant value flag used to specify if the minimum magnitude of the vectors is going to be used as the scaling variable
    
    See Also:
    
    Constant Field Values
  - MAXIMUM
```
public static final int MAXIMUM
```
    A constant value flag used to specify if the max magnitude of the vectors is going to be used as the scaling variable
    
    See Also:
    
    Constant Field Values
  - scale
```
public double scale
```
    This is the scaling to be used when drawing vectors. The scaling is the fraction of the axis the mean vector magnitude will be scaled to.
- Constructor Detail
  - VectorSet
```
public VectorSet()
          throws Exception
```
    Instantiate an empty data set.
    
    Throws:
    
    Exception - A Generic exception if it fails to instantiate the the class with the correct stride.
  - VectorSet
```
public VectorSet(double[] d,
                 int n)
          throws Exception
```
    Instantiate a DataSet with the parsed data. The double array contains the data. The data is stored in the array in the sequence
```
             x,y,dx,dy,x,y,dx,dy,...
 
```
    Where (x,y) is the position of the tail and (dx,dy) is the relative position of the head. This means that the length of the data array is 4*n.
    Parameters:
    
    d - Array containing the (x,y,dy,dx) vectors.
    
    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.
  - VectorSet
```
public VectorSet(double scale)
          throws Exception
```
    Instantiate an empty data set.
    
    Parameters:
    
    s - The scaling to use when plotting the vectors.
    
    Throws:
    
    Exception - A Generic exception if it fails to instantiate the the class with the correct stride.
  - VectorSet
```
public VectorSet(double[] d,
                 int n,
                 double scale)
          throws Exception
```
    Instantiate a DataSet with the parsed data.
    
    Parameters:
    
    d - Array containing the (x,y,dy,dx) vectors.
    
    n - Number of (x,y,dx,dy) vectors in the array.
    
    Throws:
    
    Exception - A Generic exception if it fails to load the parsed array into the class.
- Method Detail
  - setScale
```
public void setScale(double scale)
```
    Set the scaling to use when drawing vectors
    
    Parameters:
    
    scale - The scaling to employ
  - setScalingType
```
public void setScalingType(int type)
```
    Set the scaling type to use when drawing vectors
    
    Parameters:
    
    type - Either MEAN, MAXIMUM or MINIMUM.
  - getScaleFactor
```
public double getScaleFactor()
```
    return the current scaling factor. That is the calculated scaling using the axis range the mean/max/min magnitude and the percentage scale.
  - legend
```
public void legend()
```
    Draw a Vector legend in the graph window. The legend will be placed above the data window in the center
  - legend
```
public void legend(String text)
```
    Define a Vector legend in the graph window. The legend will be placed above the data window in the center
    
    Parameters:
    
    text - text to display in the legend
  - legend
```
public void legend(int x,
                   int y,
                   String text)
```
    Define a Vector legend in the graph window
    
    Overrides:
    
    legend in class DataSet
    
    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 Vector legend in the graph window
    
    Overrides:
    
    legend in class DataSet
    
    Parameters:
    
    x - data position of the legend.
    
    y - data position of the legend.
    
    text - text to display in the legend
  - draw_data
```
public void draw_data(Graphics g,
                      Rectangle bounds)
```
    Draw the vectors 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
    
    Overrides:
    
    draw_data in class DataSet
    
    Parameters:
    
    g - Graphics state
    
    bounds - The data window to draw into

Class VectorSet

Field Summary

Fields inherited from class graph.DataSet

Constructor Summary

Method Summary

Methods inherited from class graph.DataSet

Methods inherited from class java.lang.Object

Field Detail

MEAN

MINIMUM

MAXIMUM

scale

Constructor Detail

VectorSet

VectorSet

VectorSet

VectorSet

Method Detail

setScale

setScalingType

getScaleFactor

legend

legend

legend

legend

draw_data