|
JMSLTM Numerical Library 5.0.1 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.imsl.chart.AbstractChartNode com.imsl.chart.ChartNode com.imsl.chart.Data com.imsl.chart.BoxPlot
public class BoxPlot
Draws a multiple-group Box plot.
For each group of observations, the box limits represent the lower quartile (25th percentile) and upper quartile (75th percentile). The median is displayed as a line across the box. Whiskers are drawn from the upper quartile to the upper adjacent value, and from the lower quartile to the lower adjacent value.
Optional notches may be displayed to show a 95 percent confidence interval about the median, at , where IRQ is the interquartile range and n is the number of observations. Outside and far outside values may be displayed as symbols. Outside values are outside the inner fence. Far out values are outside the outer fence.
The BoxPlot has several child nodes. Any of these nodes can be disabled
by setting their "Paint" attribute to false
.
Nested Class Summary | |
---|---|
static class |
BoxPlot.Statistics
Computes the statistics for one set of observations in a Boxplot . |
Field Summary | |
---|---|
static int |
BOXPLOT_TYPE_HORIZONTAL
Value for attribute "BoxPlotType" indicating that this is a horizontal box plot. |
static int |
BOXPLOT_TYPE_VERTICAL
Value for attribute "BoxPlotType" indicating that this is a horizontal box plot. |
static long |
serialVersionUID
|
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 | |
---|---|
BoxPlot(AxisXY axis,
double[][] obs)
Constructs a box plot chart. |
|
BoxPlot(AxisXY axis,
double[] x,
BoxPlot.Statistics[] statistics)
Constructs a box plot chart node with specified x values. |
|
BoxPlot(AxisXY axis,
double[] x,
double[][] obs)
Constructs a box plot chart node with specified x values. |
Method Summary | |
---|---|
void |
dataRange(double[] range)
Update the data range, range = {xmin,xmax,ymin,ymax} . |
ChartNode |
getBodies()
Returns a node containing the body elements in the Box plot. |
int |
getBoxPlotType()
Returns the value of the "BoxPlotType" attribute. |
ChartNode |
getFarMarkers()
Returns the FarMarkers node. |
boolean |
getNotch()
Gets the "Notch" attribute value. |
ChartNode |
getOutsideMarkers()
Returns the OutsideMarkers node. |
BoxPlot.Statistics[] |
getStatistics()
Returns an array of BoxPlot.Statistics objects, one for
each set of observations. |
BoxPlot.Statistics |
getStatistics(int iSet)
Returns a BoxPlot.Statistics for a set of observations. |
ChartNode |
getWhiskers()
Returns the Whiskers node. |
boolean |
isProportionalWidth()
Returns the value of the attribute "ProportionalWidth". |
void |
paint(Draw draw)
Paints this node and all of its children. |
void |
setBoxPlotType(int value)
Sets the "BoxPlotType" attribute value. |
void |
setLabels(String[] labels)
Sets up an axis with labels. |
void |
setLabels(String[] labels,
int type)
Sets up an axis with labels. |
void |
setNotch(boolean value)
Sets the attribute "Notch". |
void |
setProportionalWidth(boolean proportionalWidth)
Sets the value of the attribute "ProportionalWidth". |
Methods inherited from class com.imsl.chart.Data |
---|
formatLabel |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int BOXPLOT_TYPE_HORIZONTAL
BoxPlot
nodes.
public static final int BOXPLOT_TYPE_VERTICAL
BoxPlot
nodes.
public static final long serialVersionUID
Constructor Detail |
---|
public BoxPlot(AxisXY axis, double[][] obs)
axis
- an AxisXY
object, the parent of this nodeobs
- a double
array which contains the observations.
The length of each row in obs
must be at least 4.public BoxPlot(AxisXY axis, double[] x, BoxPlot.Statistics[] statistics)
axis
- an AxisXY
object, the parent of this nodex
- a double
array which contains the x
valuesstatistics
- is an array of BoxPlot.Statistics
objects. The number of
BoxPlot.Statistics
must equal the
length of x
.public BoxPlot(AxisXY axis, double[] x, double[][] obs)
axis
- an AxisXY
object, the parent of this nodex
- a double
array which contains the x
valuesobs
- a double
array which contains the observations
for each x. The number of rows in obs
must equal the length of x
.
The length of each row in obs
must be at least 4.Method Detail |
---|
public void dataRange(double[] 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.
dataRange
in class Data
range
- a double
array which contains the updated
range, {xmin,xmax,ymin,ymax}public ChartNode getBodies()
ChartNode
containing the bodies.public int getBoxPlotType()
int
which contains the "BoxPlotType". Legal
values are BOXPLOT_TYPE_VERTICAL
or
BOXPLOT_TYPE_HORIZONTAL
.BOXPLOT_TYPE_VERTICAL
,
BOXPLOT_TYPE_HORIZONTAL
public ChartNode getFarMarkers()
ChartNode
containing the far markerspublic boolean getNotch()
boolean
which specifies whether the notches are
to be displayed; true
if so false
otherwise
public ChartNode getOutsideMarkers()
ChartNode
containing the outside markerspublic BoxPlot.Statistics[] getStatistics()
BoxPlot.Statistics
objects, one for
each set of observations.
BoxPlot.Statistics
objectspublic BoxPlot.Statistics getStatistics(int iSet)
BoxPlot.Statistics
for a set of observations.
iSet
- an int
which specifies the index of a set
whose statistics are to be returned
BoxPlot.Statistics
object related to the
iSet
set of observationspublic ChartNode getWhiskers()
ChartNode
containing the whiskers
public boolean isProportionalWidth()
boolean
which specifies whether the box widths
are proportional. If true
the box widths are
proportional to the square root of the number of observations.
If false
all of the boxes have the same width.public void paint(Draw draw)
paint
method in this node's parent.
paint
in class Data
draw
- the Draw
object to be paintedpublic void setBoxPlotType(int value)
value
- an int
which specifies the "BoxPlotType"
attribute. Legal values are
BOXPLOT_TYPE_VERTICAL
or
BOXPLOT_TYPE_HORIZONTAL
.BOXPLOT_TYPE_VERTICAL
,
BOXPLOT_TYPE_HORIZONTAL
public void setLabels(String[] labels)
labels
- is an array of strings with which to label the axis. The
number of labels must equal the number of items.public void setLabels(String[] labels, int type)
labels
- an array of String
s with which to label the
axis. The number of labels must equal the number of
items.type
- an int
which specifies the BoxPlotType.
Legal values are BOXPLOT_TYPE_VERTICAL
or
BOXPLOT_TYPE_HORIZONTAL
. This determines
the axis to be modified.BOXPLOT_TYPE_VERTICAL
,
BOXPLOT_TYPE_HORIZONTAL
public void setNotch(boolean value)
value
- a boolean
which specifies whether notches
are to be displayed; true
if so
false
otherwisepublic void setProportionalWidth(boolean proportionalWidth)
proportionalWidth
- a boolean
which specifies
whether the box widths are to be proportional. Is
true
if the box widths are to be proportional
to the square root of the number of observations. If
false
all of the boxes have the same width. The
default value is false
.
|
JMSLTM Numerical Library 5.0.1 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |