Package loci.formats

Enum Class AnatomicalOrientation

java.lang.Object

java.lang.Enum<AnatomicalOrientation>

loci.formats.AnatomicalOrientation

All Implemented Interfaces:

Serializable, Comparable<AnatomicalOrientation>, java.lang.constant.Constable, OrientationTerm

public enum AnatomicalOrientation
extends Enum<AnatomicalOrientation>
implements OrientationTerm

Enum of anatomical orientation terms defined in: https://ngff.openmicroscopy.org/rfc/4/#permissible-values

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANTERIOR_TO_POSTERIOR
APEX_TO_BASE
APICAL_TO_BASAL
BASAL_TO_APICAL
BASE_TO_APEX
CAUDAL_TO_CRANIAL
CAUDAL_TO_ROSTRAL
CRANIAL_TO_CAUDAL
DEEP_TO_SUPERFICIAL
DISTAL_TO_PROXIMAL
DORSAL_TO_PALMAR
DORSAL_TO_PLANTAR
DORSAL_TO_VENTRAL
INFERIOR_TO_SUPERIOR
LEFT_TO_RIGHT
PALMAR_TO_DORSAL
PLANTAR_TO_DORSAL
POSTERIOR_TO_ANTERIOR
PROXIMAL_TO_DISTAL
RIGHT_TO_LEFT
ROSTRAL_TO_CAUDAL
SUPERFICIAL_TO_DEEP
SUPERIOR_TO_INFERIOR
VENTRAL_TO_DORSAL

Field Summary

Fields

Modifier and Type	Field	Description
private String	definedTerm

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AnatomicalOrientation(String term)

Method Summary

Modifier and Type	Method	Description
AnatomicalOrientation	flip()
String	getDefinedTerm()
static AnatomicalOrientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AnatomicalOrientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT_TO_RIGHT

public static final AnatomicalOrientation LEFT_TO_RIGHT

RIGHT_TO_LEFT

public static final AnatomicalOrientation RIGHT_TO_LEFT

ANTERIOR_TO_POSTERIOR

public static final AnatomicalOrientation ANTERIOR_TO_POSTERIOR

POSTERIOR_TO_ANTERIOR

public static final AnatomicalOrientation POSTERIOR_TO_ANTERIOR

INFERIOR_TO_SUPERIOR

public static final AnatomicalOrientation INFERIOR_TO_SUPERIOR

SUPERIOR_TO_INFERIOR

public static final AnatomicalOrientation SUPERIOR_TO_INFERIOR

DORSAL_TO_VENTRAL

public static final AnatomicalOrientation DORSAL_TO_VENTRAL

VENTRAL_TO_DORSAL

public static final AnatomicalOrientation VENTRAL_TO_DORSAL

DORSAL_TO_PALMAR

public static final AnatomicalOrientation DORSAL_TO_PALMAR

PALMAR_TO_DORSAL

public static final AnatomicalOrientation PALMAR_TO_DORSAL

DORSAL_TO_PLANTAR

public static final AnatomicalOrientation DORSAL_TO_PLANTAR

PLANTAR_TO_DORSAL

public static final AnatomicalOrientation PLANTAR_TO_DORSAL

ROSTRAL_TO_CAUDAL

public static final AnatomicalOrientation ROSTRAL_TO_CAUDAL

CAUDAL_TO_ROSTRAL

public static final AnatomicalOrientation CAUDAL_TO_ROSTRAL

CRANIAL_TO_CAUDAL

public static final AnatomicalOrientation CRANIAL_TO_CAUDAL

CAUDAL_TO_CRANIAL

public static final AnatomicalOrientation CAUDAL_TO_CRANIAL

PROXIMAL_TO_DISTAL

public static final AnatomicalOrientation PROXIMAL_TO_DISTAL

DISTAL_TO_PROXIMAL

public static final AnatomicalOrientation DISTAL_TO_PROXIMAL

SUPERFICIAL_TO_DEEP

public static final AnatomicalOrientation SUPERFICIAL_TO_DEEP

DEEP_TO_SUPERFICIAL

public static final AnatomicalOrientation DEEP_TO_SUPERFICIAL

APICAL_TO_BASAL

public static final AnatomicalOrientation APICAL_TO_BASAL

BASAL_TO_APICAL

public static final AnatomicalOrientation BASAL_TO_APICAL

APEX_TO_BASE

public static final AnatomicalOrientation APEX_TO_BASE

BASE_TO_APEX

public static final AnatomicalOrientation BASE_TO_APEX

Field Details

definedTerm

private String definedTerm

Constructor Details

AnatomicalOrientation

private AnatomicalOrientation(String term)

Method Details

values

public static AnatomicalOrientation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AnatomicalOrientation valueOf(String name)

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

NullPointerException - if the argument is null

getDefinedTerm

public String getDefinedTerm()

Specified by:

getDefinedTerm in interface OrientationTerm

Returns:

the defined vocabulary term for the orientation

flip

public AnatomicalOrientation flip()

Specified by:

flip in interface OrientationTerm

Returns:

the orientation that matches multiplying this orientation's axis by -1