Axes (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.axis.Axes

```
public final class Axes
extends Object
```
An extensible enumeration of dimensional AxisTypes. Provides a core set (X, Y, Z, TIME and CHANNEL) of axis types. The get(java.lang.String) methods can be used to create new, custom axis types which will be cached for future use.

Author:

Curtis Rueden, Mark Hiner

Field Summary

Fields
Modifier and Type	Field and Description
`static AxisType`	`CHANNEL` Identifies the Channel dimensional type, representing a generic channel dimension.
`static AxisType`	`TIME` Identifies the Time dimensional type, representing a dimension consisting of time points.
`static String`	`UNKNOWN_LABEL` Label for unknown axis types, which are returned by `unknown()`.
`static AxisType`	`X` Identifies the X dimensional type, representing a dimension in the first (X) spatial dimension.
`static AxisType`	`Y` Identifies the Y dimensional type, representing a dimension in the second (Y) spatial dimension.
`static AxisType`	`Z` Identifies the Z dimensional type, representing a dimension in the third (Z) spatial dimension.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static AxisType`	`get(String label)` Accessor for an AxisType of the given label.
`static AxisType`	`get(String label, boolean spatial)` Accessor for an AxisType of the given label.
`static AxisType[]`	`knownTypes()`
`static AxisType`	`unknown()` Gets an "unknown" axis type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNKNOWN_LABEL
```
public static final String UNKNOWN_LABEL
```
    Label for unknown axis types, which are returned by unknown().
    
    See Also:
    
    Constant Field Values
  - X
```
public static final AxisType X
```
    Identifies the X dimensional type, representing a dimension in the first (X) spatial dimension.
  - Y
```
public static final AxisType Y
```
    Identifies the Y dimensional type, representing a dimension in the second (Y) spatial dimension.
  - Z
```
public static final AxisType Z
```
    Identifies the Z dimensional type, representing a dimension in the third (Z) spatial dimension.
  - TIME
```
public static final AxisType TIME
```
    Identifies the Time dimensional type, representing a dimension consisting of time points.
  - CHANNEL
```
public static final AxisType CHANNEL
```
    Identifies the Channel dimensional type, representing a generic channel dimension.
- Method Detail
  - get
```
public static AxisType get(String label)
```
    Accessor for an AxisType of the given label. Creates and caches the AxisType as a non-spatial axis if it does not already exist.
  - get
```
public static AxisType get(String label,
                           boolean spatial)
```
    Accessor for an AxisType of the given label. Creates and caches the AxisType with the given label and spatial flag if it does not already exist.
  - knownTypes
```
public static AxisType[] knownTypes()
```
    Returns:
    
    an array of AxisTypes corresponding to all currently defined axes.
  - unknown
```
public static AxisType unknown()
```
    Gets an "unknown" axis type.
    Always returns a new object, which is not part of the extended enumeration. In this way, two unknown axis types are never equal.

Class Axes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN_LABEL

X

Y

Z

TIME

CHANNEL

Method Detail

get

get

knownTypes

unknown