net.imagej.axis

Class VariableAxis

java.lang.Object

net.imagej.axis.DefaultTypedAxis

net.imagej.axis.AbstractCalibratedAxis

net.imagej.axis.VariableAxis

All Implemented Interfaces:

Axis, CalibratedAxis, TypedAxis

Direct Known Subclasses:

IdentityAxis, PolynomialAxis, Variable1Axis

public abstract class VariableAxis
extends AbstractCalibratedAxis

An CalibratedAxis whose calibration is defined by an equation with one or more variables.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
VariableAxis(AxisType type)
VariableAxis(AxisType type, String unit)

Method Summary

Modifier and Type	Method and Description
Double	get(String name) Gets the value of the variable with the given name, or null if none.
int	numVars() Gets the number of variables with assigned values.
String	particularEquation() Gets the particular equation representing values along this axis; for instance: y = (14)*x + (4).
void	set(String name, Double value) Sets the specified value to a variable of the given name.
Set<String>	vars() Gets the set of variables with assigned values.

Methods inherited from class net.imagej.axis.AbstractCalibratedAxis

averageScale, equals, hashCode, setUnit, unit

Methods inherited from class net.imagej.axis.DefaultTypedAxis

setType, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.imagej.axis.CalibratedAxis

calibratedValue, copy, generalEquation, rawValue

Methods inherited from interface net.imagej.axis.TypedAxis

setType, type

Constructor Detail

VariableAxis

public VariableAxis(AxisType type)

VariableAxis

public VariableAxis(AxisType type,
                    String unit)

Method Detail

get

public Double get(String name)

Gets the value of the variable with the given name, or null if none.

set

public void set(String name,
                Double value)

Sets the specified value to a variable of the given name.

Parameters:

name - The variable to assign.

value - The value to assign, or null to clear the variable.

numVars

public int numVars()

Gets the number of variables with assigned values.

vars

public Set<String> vars()

Gets the set of variables with assigned values.

particularEquation

public String particularEquation()

Description copied from interface: CalibratedAxis

Gets the particular equation representing values along this axis; for instance: y = (14)*x + (4).