org.janelia.saalfeldlab.n5.universe.metadata.axes

Class Axis

java.lang.Object

org.janelia.saalfeldlab.n5.universe.metadata.axes.Axis

Direct Known Subclasses:

IndexedAxis

public class Axis
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARRAY
static String	CHANNEL
protected boolean	discrete
static String	DISPLACEMENT
protected String	name
static String	SPACE
static String	TIME
protected String	type
protected String	unit

Constructor Summary

Constructors

Constructor and Description
Axis(String name) see https://ngff.openmicroscopy.org/0.4/index.html#axes-md
Axis(String type, String name) see https://ngff.openmicroscopy.org/0.4/index.html#axes-md
Axis(String type, String name, String unit) see https://ngff.openmicroscopy.org/0.4/index.html#axes-md
Axis(String type, String name, String unit, boolean discrete) see https://ngff.openmicroscopy.org/0.4/index.html#axes-md

Method Summary

Modifier and Type	Method and Description
static Axis	defaultArray(int index)
boolean	equals(Object other)
String	getName()
String	getType()
String	getUnit()
static Axis[]	space(String unit, String... names)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SPACE

public static final String SPACE

See Also:

Constant Field Values

CHANNEL

public static final String CHANNEL

See Also:

Constant Field Values

TIME

public static final String TIME

See Also:

Constant Field Values

DISPLACEMENT

public static final String DISPLACEMENT

See Also:

Constant Field Values

ARRAY

public static final String ARRAY

See Also:

Constant Field Values

type

protected String type

name

protected String name

unit

protected String unit

discrete

protected boolean discrete

Constructor Detail

Axis

public Axis(String type,
            String name,
            String unit,
            boolean discrete)

see https://ngff.openmicroscopy.org/0.4/index.html#axes-md

Parameters:

name - must be unique across all name fields (typical: t,c,z,y,x)

type - Axis.SPACE, Axis.CHANNEL, Axis.TIME, Axis.DISPLACEMENT or Axis.ARRAY (optional)

unit - must be chosen from a list of allowed units, can otherwise lead to issues down the road, e.g. in Neuroglancer (optional)

discrete - not part of the spec yet, DISCRETE means don't interpolate between values (optional)

Axis

public Axis(String name)

see https://ngff.openmicroscopy.org/0.4/index.html#axes-md

Parameters:

name - must be unique across all name fields (typical: t,c,z,y,x)

Axis

public Axis(String type,
            String name)

see https://ngff.openmicroscopy.org/0.4/index.html#axes-md

Parameters:

name - must be unique across all name fields (typical: t,c,z,y,x)

type - Axis.SPACE, Axis.CHANNEL, Axis.TIME, Axis.DISPLACEMENT or Axis.ARRAY (optional)

Axis

public Axis(String type,
            String name,
            String unit)

see https://ngff.openmicroscopy.org/0.4/index.html#axes-md

Parameters:

name - must be unique across all name fields (typical: t,c,z,y,x)

type - Axis.SPACE, Axis.CHANNEL, Axis.TIME, Axis.DISPLACEMENT or Axis.ARRAY (optional)

unit - must be chosen from a list of allowed units, can otherwise lead to issues down the road, e.g. in Neuroglancer (optional)

Method Detail

getType

public String getType()

getName

public String getName()

getUnit

public String getUnit()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

defaultArray

public static Axis defaultArray(int index)

space

public static Axis[] space(String unit,
                           String... names)