Package adams.flow.sink.sequenceplotter

Class SequencePlotPoint

java.lang.Object

adams.data.container.AbstractDataPoint

adams.data.sequence.XYSequencePoint

adams.flow.sink.sequenceplotter.SequencePlotPoint

All Implemented Interfaces:

CloneHandler, DataPoint, DataPointWithMetaData, XYSequencePointWithErrors, Serializable, Comparable

public class SequencePlotPoint
extends XYSequencePoint
implements XYSequencePointWithErrors

Extended XYSequencePoint which can store X/Y error information as well.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Double[]	m_ErrorX	the X errors.
protected Double[]	m_ErrorY	the Y errors.

Fields inherited from class adams.data.sequence.XYSequencePoint

m_ID, m_MetaData, m_X, m_Y

Fields inherited from class adams.data.container.AbstractDataPoint

m_Parent

Constructor Summary

Constructors

Constructor	Description
SequencePlotPoint()	Initializes the point.
SequencePlotPoint(double x, double y)	Initializes the point.
SequencePlotPoint(String id, double x, double y)	Initializes the point.
SequencePlotPoint(String id, double x, double y, Double[] errorX, Double[] errorY)	Initializes the point.

Method Summary

Modifier and Type	Method	Description
void	assign(DataPoint other)	Obtains the stored variables from the other data point.
Double[]	getErrorX()	Returns the error information for X.
Double[]	getErrorY()	Returns the error information for Y.
double	getMaxX()	Returns the maximum for X.
double	getMaxY()	Returns the maximum for Y.
double	getMinX()	Returns the minimum for X.
double	getMinY()	Returns the minimum for Y.
boolean	hasErrorX()	Checks whether error information for X is available.
boolean	hasErrorY()	Checks whether error information for Y is available.

Methods inherited from class adams.data.sequence.XYSequencePoint

compareTo, getID, getMetaData, getX, getY, hasID, hasMetaData, setID, setMetaData, setX, setY, toString

Methods inherited from class adams.data.container.AbstractDataPoint

equals, getClone, getParent, hasParent, setParent, toDouble, toDouble, toDouble, toDouble, toDouble, toDouble, toDouble, toDouble

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.data.container.DataPoint

getClone, getParent, hasParent, setParent

Field Detail

m_ErrorX

protected Double[] m_ErrorX

the X errors.

m_ErrorY

protected Double[] m_ErrorY

the Y errors.

Constructor Detail

SequencePlotPoint

public SequencePlotPoint()

Initializes the point.

SequencePlotPoint

public SequencePlotPoint(double x,
                         double y)

Initializes the point.

Parameters:

x - the X value

y - the Y value

SequencePlotPoint

public SequencePlotPoint(String id,
                         double x,
                         double y)

Initializes the point.

Parameters:

id - the ID, use null to ignore

x - the X value

y - the Y value

SequencePlotPoint

public SequencePlotPoint(String id,
                         double x,
                         double y,
                         Double[] errorX,
                         Double[] errorY)

Initializes the point.

Parameters:

id - the ID, use null to ignore

x - the X value

y - the Y value

errorX - the error for X (either delta or min/max)

errorY - the error for Y (either delta or min/max)

Method Detail

assign

public void assign(DataPoint other)

Obtains the stored variables from the other data point.

Specified by:

assign in interface DataPoint

Overrides:

assign in class XYSequencePoint

Parameters:

other - the data point to get the values from

getMinX

public double getMinX()

Returns the minimum for X.

Specified by:

getMinX in interface XYSequencePointWithErrors

Overrides:

getMinX in class XYSequencePoint

Returns:

the minimum

getMaxX

public double getMaxX()

Returns the maximum for X.

Specified by:

getMaxX in interface XYSequencePointWithErrors

Overrides:

getMaxX in class XYSequencePoint

Returns:

the maximum

hasErrorX

public boolean hasErrorX()

Checks whether error information for X is available.

Specified by:

hasErrorX in interface XYSequencePointWithErrors

Returns:

true if available

getErrorX

public Double[] getErrorX()

Returns the error information for X.

Specified by:

getErrorX in interface XYSequencePointWithErrors

Returns:

the error information, null if not available

getMinY

public double getMinY()

Returns the minimum for Y.

Specified by:

getMinY in interface XYSequencePointWithErrors

Overrides:

getMinY in class XYSequencePoint

Returns:

the minimum

getMaxY

public double getMaxY()

Returns the maximum for Y.

Specified by:

getMaxY in interface XYSequencePointWithErrors

Overrides:

getMaxY in class XYSequencePoint

Returns:

the maximum

hasErrorY

public boolean hasErrorY()

Checks whether error information for Y is available.

Specified by:

hasErrorY in interface XYSequencePointWithErrors

Returns:

true if available

getErrorY

public Double[] getErrorY()

Returns the error information for Y.

Specified by:

getErrorY in interface XYSequencePointWithErrors

Returns:

the error information, null if not available