net.sf.basedb.util.plot
Enum HistogramPlot.YAggregate

java.lang.Object
  java.lang.Enum<HistogramPlot.YAggregate>
      net.sf.basedb.util.plot.HistogramPlot.YAggregate

All Implemented Interfaces:

Serializable, Comparable<HistogramPlot.YAggregate>

Enclosing class:

HistogramPlot

public static enum HistogramPlot.YAggregate
extends Enum<HistogramPlot.YAggregate>

Defines what to to plot on the y axis in a histogram plot.

Enum Constant Summary

COUNT
Plot the number of spots falling into each bin.

HILOMAXMIN
Plot a high/low bar for each bin with the maximum and minimum values.

HILOSTDEV
Plot a high/low bar for each bin with the mean +/- 1 standard deviation.

MAX
Plot the maximum of all y-values for spots falling into each bin.

MEAN
Plot the mean of all y-values for spots falling into each bin.

MIN
Plot the minimum of all y-values for spots falling into each bin.

STDEV
Plot the standard deviation of all y-values for spots falling into each bin.

SUM
Plot the sum of all y-values for spots falling into each bin.

Method Summary

abstract float	getMaxY(HistogramPlot.HistogramBin bin)
float	getMinY(HistogramPlot.HistogramBin bin)
static HistogramPlot.YAggregate	valueOf(String name) Returns the enum constant of this type with the specified name.
static HistogramPlot.YAggregate[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COUNT

public static final HistogramPlot.YAggregate COUNT

Plot the number of spots falling into each bin.

SUM

public static final HistogramPlot.YAggregate SUM

Plot the sum of all y-values for spots falling into each bin.

MEAN

public static final HistogramPlot.YAggregate MEAN

Plot the mean of all y-values for spots falling into each bin.

MAX

public static final HistogramPlot.YAggregate MAX

Plot the maximum of all y-values for spots falling into each bin.

MIN

public static final HistogramPlot.YAggregate MIN

Plot the minimum of all y-values for spots falling into each bin.

STDEV

public static final HistogramPlot.YAggregate STDEV

Plot the standard deviation of all y-values for spots falling into each bin.

HILOSTDEV

public static final HistogramPlot.YAggregate HILOSTDEV

Plot a high/low bar for each bin with the mean +/- 1 standard deviation.

HILOMAXMIN

public static final HistogramPlot.YAggregate HILOMAXMIN

Plot a high/low bar for each bin with the maximum and minimum values.

Method Detail

values

public static HistogramPlot.YAggregate[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HistogramPlot.YAggregate c : HistogramPlot.YAggregate.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HistogramPlot.YAggregate valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMaxY

public abstract float getMaxY(HistogramPlot.HistogramBin bin)

getMinY

public float getMinY(HistogramPlot.HistogramBin bin)