Package org.eclipse.dawnsci.plotting.api.histogram

Class HistogramBound

java.lang.Object

org.eclipse.dawnsci.plotting.api.histogram.HistogramBound

public final class HistogramBound
extends Object

Immutable HistogramBound class. Keep immutable so that static bound defaults cannot be modified.

Field Summary

Fields

Modifier and Type	Field	Description
protected Number	bound
protected int[]	color
static final HistogramBound	DEFAULT_MAXIMUM
static final HistogramBound	DEFAULT_MINIMUM
static final HistogramBound	DEFAULT_NAN

Constructor Summary

Constructors

Constructor	Description
HistogramBound(double bound, int r, int g, int b)	Constructor used from py4j to create a histogram bound
HistogramBound(Number bound, int... color)	RGB may be null.
HistogramBound(String bound, int r, int g, int b)	Constructor used from py4j to create a histogram bound

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static HistogramBound	fromString(String encoded)
Number	getBound()
int[]	getColor()
String	getStringBound()	Used for bound values in python commands.
boolean	hasColor()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAXIMUM

public static final HistogramBound DEFAULT_MAXIMUM

DEFAULT_MINIMUM

public static final HistogramBound DEFAULT_MINIMUM

DEFAULT_NAN

public static final HistogramBound DEFAULT_NAN

bound

protected Number bound

color

protected int[] color

Constructor Details

HistogramBound

public HistogramBound(String bound,
 int r,
 int g,
 int b)

Constructor used from py4j to create a histogram bound

Parameters:

bound -

r -

g -

b -

HistogramBound

public HistogramBound(double bound,
 int r,
 int g,
 int b)

Constructor used from py4j to create a histogram bound

Parameters:

bound -

r -

g -

b -

HistogramBound

public HistogramBound(Number bound,
 int... color)

RGB may be null. If it is the last three colours in the palette are used for the bound directly. For instance RGBs can be set to null to avoid special cut bounds colors at all.

Parameters:

bound -

color -

Method Details

getBound

public Number getBound()

getColor

public int[] getColor()

hasColor

public boolean hasColor()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

fromString

public static HistogramBound fromString(String encoded)

getStringBound

public String getStringBound()

Used for bound values in python commands.

Returns: