org.diirt.graphene

Class AxisRanges

java.lang.Object

org.diirt.graphene.AxisRanges

public class AxisRanges
extends Object

Standard implementation for the logic to calculate the data range to be displayed in a graph.

There are four cases:

• Display (default): it’s the range that comes directly with the data. If it’s not set, or if it’s invalid, then it’s calculated from the data the first time and kept forever.
• Data: it’s the range of the current data being displayed. To determine the current range, all values may be scanned, and it can be costly if the dataset is large. If the data changes in time, the range displayed will grow and shrink, which may make the plot confusing.
• Fixed: use defined minimum and maximum.
• Auto: keeps growing the range so that incoming data always fits. In most cases, as data comes in, the Auto range will become stable. To deal with outliers you can specify the the minimum percentage of the range that must be used to display data. So, if you set a 80% threshold, the range will shrinks if less than 80% of the range contains actual data. This option may have the same performance issues than Data.

Author:

carcassi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AxisRanges.Auto An AxisRange with Auto value range.
static class	AxisRanges.Data An AxisRange with Fixed value range.
static class	AxisRanges.Display An AxisRange with Display value range.
static class	AxisRanges.Fixed An AxisRange with Fixed value range.

Method Summary

Modifier and Type	Method and Description
static AxisRange	auto() A range that grows to fit the current and past data.
static AxisRange	auto(double minUsage) A range that grows to fit the current and past data, and shrinks if the data shrinks more than minUsage.
static AxisRange	data() A range for the axis that fits the data.
static AxisRange	display() The suggested range for the data.
static AxisRange	fixed(double min, double max) A fixed range from the given values.

Methods inherited from class java.lang.Object

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

Method Detail

fixed

public static AxisRange fixed(double min,
                              double max)

A fixed range from the given values.

Parameters:

min - minimum value displayed on the axis

max - maximum value displayed on the axis

Returns:

the axis range; never null

data

public static AxisRange data()

A range for the axis that fits the data.

Returns:

the range; never null

auto

public static AxisRange auto()

A range that grows to fit the current and past data. If will shrink if the data shrinks to less than 80% of the range.

Returns:

an axis range; never null

auto

public static AxisRange auto(double minUsage)

A range that grows to fit the current and past data, and shrinks if the data shrinks more than minUsage. minUsage represents the minimum percentage to be used to display actual data.

Parameters:

minUsage - a number from 0.0 to 1.0

Returns:

an axis range; never null

display

public static AxisRange display()

The suggested range for the data.

Returns:

an axis range; never null