jplot

Class DataArray2D

java.lang.Object

jplot.LinePars

jplot.DataArray2D

All Implemented Interfaces:

Serializable

public class DataArray2D
extends LinePars

This is a special-purpose array for use with the graphical plotting program JHPlot. Its main functionality is to provide a series of plot points (X,Y,Z 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
DataArray2D() Default constructor, initializes the class with nothing.
DataArray2D(int size) Default constructor, initializes the class with nothing.

Method Summary

Modifier and Type	Method and Description
void	addPoint(double x, double y, double z) Adds the values of a plot-point pair (x,y,z).
void	clear() Clears the current array.
ArrayList	getData() Return the data vector
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.
PlotPoint2D	getPoint(int i) Returns the plot-point of the specified index.
String	getTitle() Get the title if any
double	getX(int i) Return a specific X-value.
double	getY(int i) Return a specific Y-value.
double	getZ(int i) Return a specific Z-value.
double	meanX()
double	meanY()
double	meanZ()
boolean	parse(BufferedReader in) Read DataArray from BufferedReader
boolean	parse(File file) Get data from a file
void	print() Print a data container on the screen
void	setPoint(int i, double x, double y, double z) Sets the values of a plot-point pair (x,y).
int	size() Return the length of the data vector.
void	toFile(String name, String title) Write a DataArray to an external file.
void	updateMean(double x, double y, double z) Updates Mean values.
void	updateMinMax(double x, double y, double z) 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, toString, wait, wait, wait

Constructor Detail

DataArray2D

public DataArray2D()

Default constructor, initializes the class with nothing.

DataArray2D

public DataArray2D(int size)

Default constructor, initializes the class with nothing.

Method Detail

updateMinMax

public void updateMinMax(double x,
                         double y,
                         double z)

Updates maximum and minimum values.

Parameters:

x - just entered x-value of the point

y - just entered y-value of the point

z - just entered z-value of the point

updateMean

public void updateMean(double x,
                       double y,
                       double z)

Updates Mean values.

Parameters:

x - just entered x-value of the point

y - just entered y-value of the point

z - just entered y-value of the point

meanX

public double meanX()

meanY

public double meanY()

meanZ

public double meanZ()

addPoint

public void addPoint(double x,
                     double y,
                     double z)

Adds the values of a plot-point pair (x,y,z). 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

z - z-value of the plot-point

setPoint

public void setPoint(int i,
                     double x,
                     double y,
                     double z)

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

z - z-value of the plot-point

getPoint

public PlotPoint2D getPoint(int i)

Returns the plot-point of the specified index.

Parameters:

i - index of the plot-point

Returns:

plotpoint at index i

size

public int size()

Return the length of the data vector.

Returns:

length of the PlotPoint vector

getData

public ArrayList 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

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

getZ

public double getZ(int i)

Return a specific Z-value. This function returns POSINF (1e300) if index i falls beyond the valid range.

Parameters:

i - index of the array

Returns:

the value of z 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. 0-x, 1-y, 2-z

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.

clear

public void clear()

Clears the current array.

toFile

public void toFile(String name,
                   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 String getTitle()

Get the title if any

Returns:

parse

public boolean parse(File file)

Get data from a file

Parameters:

file -

Returns:

parse

public boolean parse(BufferedReader in)

Read DataArray from BufferedReader

Parameters:

in - BufferedReader

Returns:

true if no error

print

public void print()

Print a data container on the screen

Overrides:

print in class LinePars