bdv.util

Enum AxisOrder

java.lang.Object

java.lang.Enum<AxisOrder>

bdv.util.AxisOrder

All Implemented Interfaces:

Serializable, Comparable<AxisOrder>, EuclideanSpace

public enum AxisOrder
extends Enum<AxisOrder>
implements EuclideanSpace

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT
XY
XYC
XYCT
XYCZ
XYCZT
XYT
XYTC
XYZ
XYZC
XYZCT
XYZT
XYZTC

Method Summary

Modifier and Type	Method and Description
int	channelDimension()
static AxisOrder	getAxisOrder(AxisOrder axisOrder, EuclideanSpace space, boolean viewerIs2D)
boolean	hasChannels()
boolean	hasTimepoints()
boolean	hasZ()
long	numChannels(Dimensions dimensions)
int	numDimensions()
long	numTimepoints(Dimensions dimensions)
static <T> Pair<ArrayList<RandomAccessible<T>>,Interval>	splitInputStackIntoSourceStacks(RandomAccessible<T> img, Interval interval, AxisOrder axisOrder)
static <T> ArrayList<RandomAccessibleInterval<T>>	splitInputStackIntoSourceStacks(RandomAccessibleInterval<T> img, AxisOrder axisOrder)
int	timeDimension()
static AxisOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxisOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
int	zDimension()

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XYZ

public static final AxisOrder XYZ

XYZC

public static final AxisOrder XYZC

XYZT

public static final AxisOrder XYZT

XYZCT

public static final AxisOrder XYZCT

XYZTC

public static final AxisOrder XYZTC

XYCZT

public static final AxisOrder XYCZT

XY

public static final AxisOrder XY

XYC

public static final AxisOrder XYC

XYT

public static final AxisOrder XYT

XYCT

public static final AxisOrder XYCT

XYTC

public static final AxisOrder XYTC

XYCZ

public static final AxisOrder XYCZ

DEFAULT

public static final AxisOrder DEFAULT

Method Detail

values

public static AxisOrder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AxisOrder c : AxisOrder.values())
    System.out.println(c);

Returns:

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

valueOf

public static AxisOrder valueOf(String name)

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

NullPointerException - if the argument is null

getAxisOrder

public static AxisOrder getAxisOrder(AxisOrder axisOrder,
                                     EuclideanSpace space,
                                     boolean viewerIs2D)

splitInputStackIntoSourceStacks

public static <T> ArrayList<RandomAccessibleInterval<T>> splitInputStackIntoSourceStacks(RandomAccessibleInterval<T> img,
                                                                                         AxisOrder axisOrder)

splitInputStackIntoSourceStacks

public static <T> Pair<ArrayList<RandomAccessible<T>>,Interval> splitInputStackIntoSourceStacks(RandomAccessible<T> img,
                                                                                                Interval interval,
                                                                                                AxisOrder axisOrder)

zDimension

public int zDimension()

hasZ

public boolean hasZ()

channelDimension

public int channelDimension()

hasChannels

public boolean hasChannels()

numChannels

public long numChannels(Dimensions dimensions)

timeDimension

public int timeDimension()

hasTimepoints

public boolean hasTimepoints()

numTimepoints

public long numTimepoints(Dimensions dimensions)

numDimensions

public int numDimensions()

Specified by:

numDimensions in interface EuclideanSpace