JMSLTM Numerical Library 6.1

com.imsl.chart
Class ErrorBar

java.lang.Object
  extended by com.imsl.chart.AbstractChartNode
      extended by com.imsl.chart.ChartNode
          extended by com.imsl.chart.Data
              extended by com.imsl.chart.ErrorBar
All Implemented Interfaces:
Serializable, Cloneable

public class ErrorBar
extends Data

Data points with error bars.

See Also:
Example, Chart Programmer's Guide: Error Bar Plot, Serialized Form

Field Summary
static int DATA_TYPE_ERROR_X
          Value for attribute "DataType" indicating that this is a horizontal error bar.
static int DATA_TYPE_ERROR_Y
          Value for attribute "DataType" indicating that this is a vertical error bar.
 
Fields inherited from class com.imsl.chart.ChartNode
AXIS_X_TOP, AXIS_Y_RIGHT, BAR_TYPE_HORIZONTAL, BAR_TYPE_VERTICAL, DASH_PATTERN_DASH, DASH_PATTERN_DASH_DOT, DASH_PATTERN_DOT, DASH_PATTERN_SOLID, DATA_TYPE_FILL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, DATA_TYPE_TUBE, DENDROGRAM_TYPE_HORIZONTAL, DENDROGRAM_TYPE_VERTICAL, FILL_TYPE_GRADIENT, FILL_TYPE_NONE, FILL_TYPE_PAINT, FILL_TYPE_SOLID, LABEL_TYPE_PERCENT, MARKER_TYPE_ASTERISK, MARKER_TYPE_CIRCLE_CIRCLE, MARKER_TYPE_CIRCLE_PLUS, MARKER_TYPE_CIRCLE_X, MARKER_TYPE_DIAMOND_PLUS, MARKER_TYPE_FILLED_CIRCLE, MARKER_TYPE_FILLED_DIAMOND, MARKER_TYPE_FILLED_SQUARE, MARKER_TYPE_FILLED_TRIANGLE, MARKER_TYPE_HOLLOW_CIRCLE, MARKER_TYPE_HOLLOW_DIAMOND, MARKER_TYPE_HOLLOW_SQUARE, MARKER_TYPE_HOLLOW_TRIANGLE, MARKER_TYPE_OCTAGON_PLUS, MARKER_TYPE_OCTAGON_X, MARKER_TYPE_PLUS, MARKER_TYPE_SQUARE_PLUS, MARKER_TYPE_SQUARE_X, MARKER_TYPE_X, TEXT_X_CENTER, TEXT_X_LEFT, TEXT_X_RIGHT, TEXT_Y_BOTTOM, TEXT_Y_CENTER, TEXT_Y_TOP
 
Fields inherited from class com.imsl.chart.AbstractChartNode
AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_Y, AXIS_Z, LABEL_TYPE_NONE, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, LABEL_TYPE_Z, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG
 
Constructor Summary
ErrorBar(AxisXY axis, double[] x, double[] y, double[] low, double[] high)
          Creates a set of error bars centered at (x[k],y[k]) and with extents low[k],high[k].
 
Method Summary
 void dataRange(double[] range)
          Update the data range, range = {xmin,xmax,ymin,ymax}.
 double[] getHigh()
          Convenience routine to get the "High" attribute.
 double[] getLow()
          Convenience routine to get the "Low" attribute.
 void paint(Draw draw)
          Paints this node and all of its children.
 void setHigh(double[] value)
          Convenience routine to set the "High" attribute.
 void setLow(double[] value)
          Convenience routine to set the "Low" attribute.
 
Methods inherited from class com.imsl.chart.Data
formatLabel
 
Methods inherited from class com.imsl.chart.ChartNode
addPickListener, firePickListeners, getALT, getAxis, getBackground, getBarGap, getBarType, getBarWidth, getChart, getChartTitle, getChildren, getClipData, getComponent, getConcatenatedViewport, getDataType, getDoubleBuffering, getExplode, getFillOutlineColor, getFillOutlineType, getFillPaint, getFillType, getGradient, getHREF, getLegend, getLineDashPattern, getMarkerDashPattern, getMarkerThickness, getMarkerType, getParent, getReference, getScreenAxis, getScreenSize, getScreenViewport, getSize, getSkipWeekends, getTextAngle, getTextColor, getTitle, getToolTip, getViewport, isBitSet, prePaint, removePickListener, setALT, setBarGap, setBarType, setBarWidth, setChartTitle, setClipData, setCustomTransform, setDataType, setDoubleBuffering, setExplode, setFillOutlineColor, setFillOutlineColor, setFillOutlineType, setFillPaint, setFillPaint, setFillPaint, setFillType, setGradient, setGradient, setGradient, setHREF, setImage, setLineDashPattern, setMarkerDashPattern, setMarkerThickness, setMarkerType, setReference, setScreenSize, setSize, setSkipWeekends, setTextAngle, setTextColor, setTextColor, setTitle, setTitle, setToolTip, setViewport, setViewport
 
Methods inherited from class com.imsl.chart.AbstractChartNode
clone, clone, clone, clone, getAbstractParent, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getBooleanAttribute, getChildList, getColorAttribute, getCustomTransform, getDensity, getDoubleAttribute, getFillColor, getFont, getFontName, getFontSize, getFontStyle, getImage, getIntegerAttribute, getLabelType, getLightColor, getLineColor, getLineWidth, getLocale, getMarkerColor, getMarkerSize, getName, getNumber, getPaint, getStringAttribute, getTextFormat, getTickLength, getTransform, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, parseColor, remove, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setDensity, setFillColor, setFillColor, setFont, setFontName, setFontSize, setFontStyle, setImage, setLabelType, setLightColor, setLightColor, setLineColor, setLineColor, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerSize, setName, setNumber, setPaint, setTextFormat, setTextFormat, setTickLength, setTransform, setX, setY, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DATA_TYPE_ERROR_X

public static final int DATA_TYPE_ERROR_X
Value for attribute "DataType" indicating that this is a horizontal error bar. Used in connection with ErrorBar nodes.

See Also:
Constant Field Values

DATA_TYPE_ERROR_Y

public static final int DATA_TYPE_ERROR_Y
Value for attribute "DataType" indicating that this is a vertical error bar. Used in connection with ErrorBar nodes.

See Also:
Constant Field Values
Constructor Detail

ErrorBar

public ErrorBar(AxisXY axis,
                double[] x,
                double[] y,
                double[] low,
                double[] high)
Creates a set of error bars centered at (x[k],y[k]) and with extents low[k],high[k]. If the attribute "DataType" has the bit DATA_TYPE_ERROR_X set then this is a horizontal error bar. If the bit DATA_TYPE_ERROR_Y is set then this is a vertical error bar. If neither bit is set then no error bar is drawn.

A Data node with the same x and y values can be used to put markers at the center of each error bar.

Parameters:
axis - an Axis object
x - a double array which contains the x coordinates of the points at which the error bars will be centered. This is used to set the "X" attribute.
y - a double array which contains the y coordinates of the points at which the error bars will be centered. This is used to set the "Y" attribute.
low - a double array which contains the values which define the minimum extent of the error bars. This is used to set the "Low" attribute.
high - a double array which contains the values which define the maximum extent of the error bars. This is used to set the "High" attribute.
Method Detail

dataRange

public void dataRange(double[] range)
Update the data range, range = {xmin,xmax,ymin,ymax}. The entries in range are updated to reflect the extent of the data in this node. The argument range is an input/output variable. Its value should be updated only if the data in this node is outside the range already in the array.

Overrides:
dataRange in class Data
Parameters:
range - a double array which contains the updated range, {xmin,xmax,ymin,ymax}

getHigh

public double[] getHigh()
Convenience routine to get the "High" attribute.

Returns:
the double array which contains the value of the "High" attribute

getLow

public double[] getLow()
Convenience routine to get the "Low" attribute.

Returns:
the double array which contains the value of the "Low" attribute

paint

public void paint(Draw draw)
Paints this node and all of its children. This is normally called only by the paint method in this node's parent.

Overrides:
paint in class Data
Parameters:
draw - the Draw object to be painted

setHigh

public void setHigh(double[] value)
Convenience routine to set the "High" attribute.

Parameters:
value - an double array which contains the "High" values.

setLow

public void setLow(double[] value)
Convenience routine to set the "Low" attribute.

Parameters:
value - an double array which contains the "Low" values.

JMSLTM Numerical Library 6.1

Copyright © 1970-2010 Visual Numerics, Inc.
Built July 30 2010.