AbstractCalibratedAxis (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.axis.DefaultTypedAxis
- - net.imagej.axis.AbstractCalibratedAxis

All Implemented Interfaces:

Axis, CalibratedAxis, TypedAxis

Direct Known Subclasses:

EnumeratedAxis, VariableAxis
```
public abstract class AbstractCalibratedAxis
extends DefaultTypedAxis
implements CalibratedAxis
```
Abstract base class for CalibratedAxis.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

AbstractCalibratedAxis(AxisType type)

AbstractCalibratedAxis(AxisType type, String unit)

Constructors
Constructor and Description
`AbstractCalibratedAxis(AxisType type)`
`AbstractCalibratedAxis(AxisType type, String unit)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`averageScale(double rawValue1, double rawValue2)` Returns the average scale between two raw value coordinates along an axis.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`void`	`setUnit(String unit)` Sets the dimension's unit.
`String`	`unit()` Gets the dimension's 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, particularEquation, rawValue

Methods inherited from interface net.imagej.axis.TypedAxis
setType, type

- Constructor Detail
  - AbstractCalibratedAxis
```
public AbstractCalibratedAxis(AxisType type)
```
  - AbstractCalibratedAxis
```
public AbstractCalibratedAxis(AxisType type,
                              String unit)
```
- Method Detail
  - unit
```
public String unit()
```
    Description copied from interface: CalibratedAxis
    
    Gets the dimension's unit.
    
    Specified by:
    
    unit in interface CalibratedAxis
  - setUnit
```
public void setUnit(String unit)
```
    Description copied from interface: CalibratedAxis
    
    Sets the dimension's unit.
    
    Specified by:
    
    setUnit in interface CalibratedAxis
  - averageScale
```
public double averageScale(double rawValue1,
                           double rawValue2)
```
    Description copied from interface: CalibratedAxis
    
    Returns the average scale between two raw value coordinates along an axis.
    In the limit this is actually the derivative at a point. For linear axes this value never varies, and there is no error. For nonlinear axes this returns the linear scale between the points and thus may be inaccurate. Calls to this method may point out areas of code that should be generalized to work with nonlinear axes.
    
    Specified by:
    
    averageScale in interface CalibratedAxis
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object

Class AbstractCalibratedAxis

Constructor Summary

Method Summary

Methods inherited from class net.imagej.axis.DefaultTypedAxis

Methods inherited from class java.lang.Object

Methods inherited from interface net.imagej.axis.CalibratedAxis

Methods inherited from interface net.imagej.axis.TypedAxis

Constructor Detail

AbstractCalibratedAxis

AbstractCalibratedAxis

Method Detail

unit

setUnit

averageScale

hashCode

equals