jplot

Class DataArray3D

java.lang.Object

jplot.LinePars

jplot.DataArray3D

All Implemented Interfaces:

Serializable

public class DataArray3D
extends LinePars

This is a special-purpose array for use with the graphical plotting program JHPlot. Its main functionallity is to provide a series of plot points (X,Y,Z) pairs which form a surface.

See Also:

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
DataArray3D() Default constructor, initializes the class with nothing.

Method Summary

Modifier and Type	Method and Description
void	addPoint(double x, double dx, double y, double dy, double z, double dz) Adds the values of a plot-point pair (x,y,z).
void	clear() Clears the current array.
ArrayList	getData() Return the data vector
double	getDX(int i) Return a specific DX-value.
double	getDY(int i) Return a specific DY-value.
double	getDZ(int i) Return a specific DZ-value.
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.
PlotPoint3D	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	setLinePars(LinePars l) Sets the drawing style parameters at once.
void	setPoint(int i, double x, double dx, double y, double dy, double z, double dz) 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(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

DataArray3D

public DataArray3D()

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 dx,
                     double y,
                     double dy,
                     double z,
                     double dz)

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

dx - dx extention in x

y - y-value of the plot-point

dy - dy extention in y

z - z-value of the plot-point

dz - dz extention in z

setPoint

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

Sets the values of a plot-point pair (x,y).

Parameters:

i - index of the plot-point

x - x-value of the plot-point

dx - dx extention in x

y - y-value of the plot-point

dy - dy extention in y

z - z-value of the plot-point

dz - dz extention in z

getPoint

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

getDX

public double getDX(int i)

Return a specific DX-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

getDY

public double getDY(int i)

Return a specific DY-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

getDZ

public double getDZ(int i)

Return a specific DZ-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.

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)

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(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