DataArray

java.lang.Object
- jplot.LinePars
- - jplot.DataArray

All Implemented Interfaces:

java.io.Serializable
```
public class DataArray
extends LinePars
implements java.io.Serializable
```
This is a special-purpose array for use with the graphical plotting program JPlot. Its main functionality is to provide a series of plot points (X,Y pairs) which form a line or something to plot.
A data array has plotting attributes, e.g. saying whether we should plot symbols, draw lines or fill areas. All the plotting attributes are defined in the base-class LinePars, here we set the actual data array, i.e. a vector of points (PlotPoints) defining X,Y.

See Also:

LinePars, Serialized Form

Field Summary
- Fields inherited from class jplot.LinePars
  CONTOUR, F1D, H1D, H2D, H3D, HISTO, LINES, P1D, STICKS

Constructor Summary

Constructors
Constructor and Description
`DataArray()` Default constructor, initializes the class with nothing.
`DataArray(int file, int col)` Initializes the class with a file- and column index.
`DataArray(int file, int col, int n)` Initializes the class with a file- and column index and allocates memory for the data points.
`DataArray(int file, int col, int n, LinePars lp)` Initializes the class with a file- and column index and allocates memory for the data points.
`DataArray(int file, LinePars lp)` Initializes the class with a file- and column index and allocates memory for the data points.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(double x, double y)` Adds the values of a plot-point pair (x,y).
`void`	`addPoint(double x, double y, boolean liftPen)` Adds the values of a plot-point pair (x,y).
`void`	`addPoint(double x, double y, double upper, double lower)` Adds the values of a plot-point pair (x,y).
`void`	`addPoint(double x, double y, double left, double right, double upper, double lower)` Adds the values of a plot-point pair (x,y).
`void`	`addPoint(double x, double y, double left, double right, double upper, double lower, double left_sys, double right_sys, double upper_sys, double lower_sys)` Adds the values of a plot-point pair (x,y).
`void`	`allocate(int n)` Allocation of memory for the data points.
`void`	`allUpdate()` update all min and max.
`void`	`clear()` Clears the current array.
`int`	`getColumnIndex()` Returns the column index of this data array.
`java.util.Vector`	`getData()` Return the data vector
`int`	`getDimension()` Return the dimension of this data
`int`	`getFileIndex()` Returns the file index of this data array.
`LinePars`	`getLinePars()` Get the drawing style parameters at once.
`double`	`getLowestNonZeroValue(int axis)` Returns the lowest, but non-zero value in the range.
`double`	`getMaxValue(int axis)` Returns the maximum value in the range.
`double`	`getMinValue(int axis)` Returns the minimum value in the range.
`PlotPoint`	`getPoint(int i)` Returns the plot-point of the specified index.
`java.awt.BasicStroke`	`getStroke()` Returns the stroke used to plot these points.
`java.lang.String`	`getTitle()` Get the title if any
`double`	`getX(int i)` Return a specific X-value.
`double`	`getXleft(int i)` Return a specific left error on X-value.
`double`	`getXleftSys(int i)` Return a specific left error on X-value (systematical error).
`double`	`getXright(int i)` Return a specific right error on X-value.
`double`	`getXrightSys(int i)` Return a specific right error on X-value (systematical error).
`double`	`getY(int i)` Return a specific Y-value.
`double`	`getYlower(int i)` Return a specific lower error on Y-value.
`double`	`getYlowerSys(int i)` Return a specific total lower error on Y-value.
`double`	`getYupper(int i)` Return a specific upper error on Y-value.
`double`	`getYupperSys(int i)` Return a specific systematical upper error on Y-value.
`boolean`	`liftPen(int i)`
`double`	`mean()`
`boolean`	`parse(java.io.BufferedReader in)` Read DataArray from BufferedReader
`boolean`	`parse(java.io.File file)` Get data from a file
`void`	`print()` Convert to string
`void`	`replacePoint(int i, double x, double y, double left, double right, double upper, double lower, double left_sys, double right_sys, double upper_sys, double lower_sys)` Replace the values of a plot-point pair (x,y).
`void`	`setDimension(int dimension)` Set the dimension of this data
`void`	`setLiftPen(int i)` Defines that, for this plotpoint, the pen should lift.
`void`	`setLinePars(LinePars l)` Sets the drawing style parameters at once.
`void`	`setPoint(int i, double x, double y)` Sets the values of a plot-point pair (x,y).
`void`	`setPoint(int i, double x, double y, double upper, double lower)` Sets the values of a plot-point pair (x,y).
`void`	`setPoint(int i, double x, double y, double left, double right, double upper, double lower)` Sets the values of a plot-point pair (x,y).
`void`	`setPoint(int i, double x, double y, double left, double right, double upper, double lower, double left_sys, double right_sys, double upper_sys, double lower_sys)` Sets the values of a plot-point pair (x,y).
`int`	`size()` Return the length of the data vector.
`void`	`sort(boolean ascending)` Sorts the arrays in ascending or descending order.
`void`	`toFile(java.lang.String name, java.lang.String title)` Write a DataArray to an external file.
`java.lang.String`	`toString()` Print a data container on the screen
`void`	`updateMean(double x, double y)` Updates Mean values.
`void`	`updateMinMax(double x, double y)` Updates maximum and minimum values.
`void`	`updateMinMax(double x, double y, double left, double right, double upper, double lower)` Updates maximum and minimum values.
`void`	`updateMinMax(double x, double y, double left, double right, double upper, double lower, double left_sys, double right_sys, double upper_sys, double lower_sys)` Updates maximum and minimum values.

Methods inherited from class jplot.LinePars
copy, dataChanged, drawLegend, drawLine, drawSymbol, errorsFill, errorsFillSys, errorsSysX, errorsSysY, errorsX, errorsY, fill, fill, getAdditioner, getAttributes, getColor, getColorErrorsFill, getColorErrorsFillSys, getColorErrorsSysX, getColorErrorsSysY, getColorErrorsX, getColorErrorsY, getColorIndex, getDashIndex, getDashLength, getEndColor, getErrorFillColorTransp, getErrorFillColorTranspSys, getErrorsFill, getErrorsFillSys, getErrorsSysX, getErrorsSysY, getErrorsX, getErrorsY, getErrTicSize, getFillColor, getFillColorTransparency, getGraphStyle, getMultiplier, getName, getNameX, getNameY, getNameZ, getPenWidth, getPenWidthErr, getPenWidthErrSys, getPointFrequency, getSettings, getStartColor, getSymbol, getSymbolSize, getType, getWidthBin, isBarShown, isDrawLine, isDrawSymbol, nextColor, print, setAdditioner, setColor, setColor, setColorErrorsFill, setColorErrorsFillSys, setColorErrorsSysX, setColorErrorsSysY, setColorErrorsX, setColorErrorsY, setDashLength, setDashLength, setDataChanged, setDrawLegend, setDrawLine, setDrawSymbol, setErrorFillColorTransp, setErrorFillColorTranspSys, setErrTicSize, setFillColor, setFillColorTransparency, setGraphStyle, setMultiplier, setName, setNameX, setNameY, setNameZ, setPenWidth, setPenWidthErr, setPenWidthErrSys, setPointFrequency, setShowBars, setSlideColor, setSlideColor, setSymbol, setSymbolSize, setType, setWidthBin, slideColor, updateSettings

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

- Constructor Detail
  - DataArray
```
public DataArray()
```
    Default constructor, initializes the class with nothing.
  - DataArray
```
public DataArray(int file,
                 int col)
```
    Initializes the class with a file- and column index. The indices are numbers, kind of tags of this array. The file-index should point to the data file index (in the order displayed by the PlotPanels), and the column-index is the n'th Y-column plotted by the current array.
    
    Parameters:
    
    file - index of the file
    
    col - index of the column
  - DataArray
```
public DataArray(int file,
                 int col,
                 int n)
```
    Initializes the class with a file- and column index and allocates memory for the data points. The indices are numbers, kind of tags of this array. The file-index should point to the data file index (in the order displayed by the PlotPanels), and the column-index is the n'th Y-column plotted by the current array.
    
    Parameters:
    
    file - index of the file
    
    col - index of the column
    
    n - buffer, maximum number of datapoints.
  - DataArray
```
public DataArray(int file,
                 int col,
                 int n,
                 LinePars lp)
```
    Initializes the class with a file- and column index and allocates memory for the data points. The indices are numbers, kind of tags of this array. The file-index should point to the data file index (in the order displayed by the PlotPanels), and the column-index is the n'th Y-column plotted by the current array.
    
    Parameters:
    
    file - index of the file
    
    col - index of the column
    
    n - buffer, maximum number of datapoints.
    
    lp - line parameters class, contains info of how to draw the line.
  - DataArray
```
public DataArray(int file,
                 LinePars lp)
```
    Initializes the class with a file- and column index and allocates memory for the data points. The indices are numbers, kind of tags of this array. The file-index should point to the data file index (in the order displayed by the PlotPanels), and the column-index is the n'th Y-column plotted by the current array.
    
    Parameters:
    
    file - index of the file
    
    col - index of the column
    
    n - buffer, maximum number of datapoints.
    
    lp - line parameters class, contains info of how to draw the line.
- Method Detail
  - allocate
```
public void allocate(int n)
```
    Allocation of memory for the data points.
    
    Parameters:
    
    n - maximum number of datapoints.
  - updateMinMax
```
public void updateMinMax(double x,
                         double y)
```
    Updates maximum and minimum values.
    
    Parameters:
    
    x - just entered x-value of the point
    
    y - just entered y-value of the point
  - updateMinMax
```
public void updateMinMax(double x,
                         double y,
                         double left,
                         double right,
                         double upper,
                         double lower)
```
    Updates maximum and minimum values. Takes care of errors.
    
    Parameters:
    
    x - just entered x-value of the point
    
    y - just entered y-value of the point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
  - updateMinMax
```
public void updateMinMax(double x,
                         double y,
                         double left,
                         double right,
                         double upper,
                         double lower,
                         double left_sys,
                         double right_sys,
                         double upper_sys,
                         double lower_sys)
```
    Updates maximum and minimum values. Takes care of errors.
    
    Parameters:
    
    x - just entered x-value of the point
    
    y - just entered y-value of the point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
    
    left_sys - - error on x (left) - second level, used for systematics
    
    right_sys - - error on x (right)
    
    upper_sys - - error on y (upper)
    
    lower_sys - - error on y (lower)
  - updateMean
```
public void updateMean(double x,
                       double y)
```
    Updates Mean values.
    
    Parameters:
    
    x - just entered x-value of the point
    
    y - just entered y-value of the point
  - mean
```
public double mean()
```
  - addPoint
```
public void addPoint(double x,
                     double y)
```
    Adds the values of a plot-point pair (x,y). This point is added at the end of the array.
    
    Parameters:
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
  - addPoint
```
public void addPoint(double x,
                     double y,
                     double upper,
                     double lower)
```
    Adds the values of a plot-point pair (x,y). it alos incudes upper and lower errors This point is added at the end of the array.
    
    Parameters:
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
  - addPoint
```
public void addPoint(double x,
                     double y,
                     double left,
                     double right,
                     double upper,
                     double lower)
```
    Adds the values of a plot-point pair (x,y). it alos incudes upper and lower errors on X and Y This point is added at the end of the array.
    
    Parameters:
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
  - addPoint
```
public void addPoint(double x,
                     double y,
                     double left,
                     double right,
                     double upper,
                     double lower,
                     double left_sys,
                     double right_sys,
                     double upper_sys,
                     double lower_sys)
```
    Adds the values of a plot-point pair (x,y). it alos incudes upper and lower errors on X and Y This point is added at the end of the array.
    
    Parameters:
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
    
    left_sys - - error on x (left) - second level, used for systematics
    
    right_sys - - error on x (right)
    
    upper_sys - - error on y (upper)
    
    lower_sys - - error on y (lower)
  - addPoint
```
public void addPoint(double x,
                     double y,
                     boolean liftPen)
```
    Adds the values of a plot-point pair (x,y). This point is added at the end of the array.
    
    Parameters:
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    liftPen - true if the pen should lift after this point
  - setPoint
```
public void setPoint(int i,
                     double x,
                     double y)
```
    Sets the values of a plot-point pair (x,y).
    
    Parameters:
    
    i - index of the plot-point
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
  - setPoint
```
public void setPoint(int i,
                     double x,
                     double y,
                     double upper,
                     double lower)
```
    Sets the values of a plot-point pair (x,y).
    
    Parameters:
    
    i - index of the plot-point
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    upper - upper error on y
    
    lower - lower error on y
  - setPoint
```
public void setPoint(int i,
                     double x,
                     double y,
                     double left,
                     double right,
                     double upper,
                     double lower)
```
    Sets the values of a plot-point pair (x,y).
    
    Parameters:
    
    i - index of the plot-point
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
  - setPoint
```
public void setPoint(int i,
                     double x,
                     double y,
                     double left,
                     double right,
                     double upper,
                     double lower,
                     double left_sys,
                     double right_sys,
                     double upper_sys,
                     double lower_sys)
```
    Sets the values of a plot-point pair (x,y).
    
    Parameters:
    
    i - index of the plot-point
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
    
    left_sys - - error on x (left) - second level, used for systematics
    
    right_sys - - error on x (right)
    
    upper_sys - - error on y (upper)
    
    lower_sys - - error on y (lower)
  - replacePoint
```
public void replacePoint(int i,
                         double x,
                         double y,
                         double left,
                         double right,
                         double upper,
                         double lower,
                         double left_sys,
                         double right_sys,
                         double upper_sys,
                         double lower_sys)
```
    Replace the values of a plot-point pair (x,y).
    
    Parameters:
    
    i - index of the plot-point
    
    x - x-value of the plot-point
    
    y - y-value of the plot-point
    
    left - - error on x (left)
    
    right - - error on x (right)
    
    upper - - error on y (upper)
    
    lower - - error on y (lower)
    
    left_sys - - error on x (left) - second level, used for systematics
    
    right_sys - - error on x (right)
    
    upper_sys - - error on y (upper)
    
    lower_sys - - error on y (lower)
  - allUpdate
```
public void allUpdate()
```
    update all min and max. Call this after all replacements are done.
  - getPoint
```
public PlotPoint getPoint(int i)
```
    Returns the plot-point of the specified index.
    
    Parameters:
    
    i - index of the plot-point
    
    Returns:
    
    plotpoint at index i
  - setLiftPen
```
public void setLiftPen(int i)
```
    Defines that, for this plotpoint, the pen should lift. This allows to draw discontinuous graphs.
    
    Parameters:
    
    i - index of the plot-point
  - liftPen
```
public boolean liftPen(int i)
```
  - size
```
public int size()
```
    Return the length of the data vector.
    
    Returns:
    
    length of the PlotPoint vector
  - getDimension
```
public int getDimension()
```
    Return the dimension of this data
    
    Returns:
    
    dimension
  - setDimension
```
public void setDimension(int dimension)
```
    Set the dimension of this data
    
    Parameters:
    
    dimension -
  - getData
```
public java.util.Vector getData()
```
    Return the data vector
    
    Returns:
    
    data vector with all the plot points
  - getX
```
public double getX(int i)
```
    Return a specific X-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of x at index i
  - getXleft
```
public double getXleft(int i)
```
    Return a specific left error on X-value. if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of x at index i
  - getXright
```
public double getXright(int i)
```
    Return a specific right error on X-value. if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of x at index i
  - getXleftSys
```
public double getXleftSys(int i)
```
    Return a specific left error on X-value (systematical error). if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of x at index i
  - getXrightSys
```
public double getXrightSys(int i)
```
    Return a specific right error on X-value (systematical error). if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of x at index i
  - getY
```
public double getY(int i)
```
    Return a specific Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of y at index i
  - getYupper
```
public double getYupper(int i)
```
    Return a specific upper error on Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of y at index i
  - getYlower
```
public double getYlower(int i)
```
    Return a specific lower error on Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of y at index i
  - getYupperSys
```
public double getYupperSys(int i)
```
    Return a specific systematical upper error on Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of y at index i
  - getYlowerSys
```
public double getYlowerSys(int i)
```
    Return a specific total lower error on Y-value. This function returns POSINF (1e300) if index i falls beyond the valid range.
    
    Parameters:
    
    i - index of the array
    
    Returns:
    
    the value of y at index i
  - getMaxValue
```
public double getMaxValue(int axis)
```
    Returns the maximum value in the range. Careful, no error checking on the value of axis, which should be less than N_AXES, defined in GraphSettings.
    
    Parameters:
    
    axis - defines to which axis this function applies.
    
    Returns:
    
    the maximum value.
  - getMinValue
```
public double getMinValue(int axis)
```
    Returns the minimum value in the range. Careful, no error checking on the value of axis, which should be less than N_AXES, defined in GraphSettings.
    
    Parameters:
    
    axis - defines to which axis this function applies.
    
    Returns:
    
    the minimum value.
  - getLowestNonZeroValue
```
public double getLowestNonZeroValue(int axis)
```
    Returns the lowest, but non-zero value in the range. This is a a usefull 'minimum' value for e.g. logarithmic ranges.
    
    Parameters:
    
    axis - defines to which axis this function applies.
    
    Returns:
    
    the minimum value.
  - getStroke
```
public java.awt.BasicStroke getStroke()
```
    Returns the stroke used to plot these points. By default, a solid line of width 1 is assumed.
    
    Returns:
    
    the actual stroke.
  - setLinePars
```
public void setLinePars(LinePars l)
```
    Sets the drawing style parameters at once.
    
    Parameters:
    
    l - line and point drawing parameters.
  - getLinePars
```
public LinePars getLinePars()
```
    Get the drawing style parameters at once. can be done in the future (not functional)
  - getFileIndex
```
public int getFileIndex()
```
    Returns the file index of this data array. This is the index of the file from which this data has been taken.
    
    Returns:
    
    file index of this array.
  - getColumnIndex
```
public int getColumnIndex()
```
    Returns the column index of this data array. This is the index of the column of the file from which this data has been taken.
    
    Returns:
    
    column index of this array.
  - clear
```
public void clear()
```
    Clears the current array.
  - sort
```
public void sort(boolean ascending)
```
    Sorts the arrays in ascending or descending order.
    
    Parameters:
    
    ascending - true if we should sort from small to large
  - toFile
```
public void toFile(java.lang.String name,
                   java.lang.String title)
```
    Write a DataArray to an external file. If errors on data points are not given, they are set to 0
    
    Parameters:
    
    name - File name with output
    
    title - Title
  - getTitle
```
public java.lang.String getTitle()
```
    Get the title if any
    
    Returns:
  - parse
```
public boolean parse(java.io.File file)
```
    Get data from a file
    
    Parameters:
    
    file -
    
    Returns:
  - parse
```
public boolean parse(java.io.BufferedReader in)
```
    Read DataArray from BufferedReader
    
    Parameters:
    
    in - BufferedReader
    
    Returns:
    
    true if no error
  - print
```
public void print()
```
    Convert to string
    
    Overrides:
    
    print in class LinePars
  - toString
```
public java.lang.String toString()
```
    Print a data container on the screen
    
    Overrides:
    
    toString in class java.lang.Object

Class DataArray

Field Summary

Fields inherited from class jplot.LinePars

Constructor Summary

Method Summary

Methods inherited from class jplot.LinePars

Methods inherited from class java.lang.Object

Constructor Detail

DataArray

DataArray

DataArray

DataArray

DataArray

Method Detail

allocate

updateMinMax

updateMinMax

updateMinMax

updateMean

mean

addPoint

addPoint

addPoint

addPoint

addPoint

setPoint

setPoint

setPoint

setPoint

replacePoint

allUpdate

getPoint

setLiftPen

liftPen

size

getDimension

setDimension

getData

getX

getXleft

getXright

getXleftSys

getXrightSys

getY

getYupper

getYlower

getYupperSys

getYlowerSys

getMaxValue

getMinValue

getLowestNonZeroValue

getStroke

setLinePars

getLinePars

getFileIndex

getColumnIndex

clear

sort

toFile

getTitle

parse

parse

print

toString