Package io.deephaven.plot.axistransformations

Enum Class AxisTransforms

java.lang.Object

java.lang.Enum<AxisTransforms>

io.deephaven.plot.axistransformations.AxisTransforms

All Implemented Interfaces:

AxisTransform, Serializable, Comparable<AxisTransforms>, java.lang.constant.Constable

public enum AxisTransforms
extends Enum<AxisTransforms>
implements AxisTransform, Serializable

Common AxisTransforms.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOG	Natural logarithm.
SQRT	Square root.

Method Summary

Modifier and Type	Method	Description
static AxisTransform	axisTransform(String name)	Returns an axis transform.
static String[]	axisTransformNames()	Returns the names of available axis transforms.
double	inverseTransform(double axisValue)	Transforms a point in Axis space to dataset space.
boolean	isVisible(double dataValue)	Gets whether a data point is visible in the plot.
double	transform(double dataValue)	Transforms a data point to Axis space.
static AxisTransforms	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AxisTransforms[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOG

public static final AxisTransforms LOG

Natural logarithm. Non-positive data values are not displayed.

SQRT

public static final AxisTransforms SQRT

Square root. Negative data values are not displayed.

Method Details

values

public static AxisTransforms[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AxisTransforms valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

transform

public double transform(double dataValue)

Description copied from interface: AxisTransform

Transforms a data point to Axis space.

Specified by:

transform in interface AxisTransform

Parameters:

dataValue - data point

Returns:

corresponding value in Axis space

inverseTransform

public double inverseTransform(double axisValue)

Description copied from interface: AxisTransform

Transforms a point in Axis space to dataset space.

Specified by:

inverseTransform in interface AxisTransform

Parameters:

axisValue - Axis space data point

Returns:

corresponding value in dataset space

isVisible

public boolean isVisible(double dataValue)

Description copied from interface: AxisTransform

Gets whether a data point is visible in the plot.

Specified by:

isVisible in interface AxisTransform

Parameters:

dataValue - data point

Returns:

whether dataValue is visible in the plot

axisTransform

public static AxisTransform axisTransform(String name)

Returns an axis transform.

Parameters:

name - case insensitive transform name.

Returns:

requested axis transform.

Throws:

IllegalArgumentException - name must not be null.

axisTransformNames

public static String[] axisTransformNames()

Returns the names of available axis transforms.

Returns:

an array of the available axis transform names.