Module org.scijava.ops.image

Package org.scijava.ops.image.image.cooccurrenceMatrix

Enum MatrixOrientation2D

java.lang.Object

java.lang.Enum<MatrixOrientation2D>

org.scijava.ops.image.image.cooccurrenceMatrix.MatrixOrientation2D

All Implemented Interfaces:

Serializable, Comparable<MatrixOrientation2D>, MatrixOrientation

public enum MatrixOrientation2D
extends Enum<MatrixOrientation2D>
implements MatrixOrientation

Orientation of a CooccurrenceMatrix2D

Author:

Christian Dietz (University of Konstanz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANTIDIAGONAL
DIAGONAL
HORIZONTAL
VERTICAL

Method Summary

Modifier and Type	Method	Description
MatrixOrientation	getByName(String name)
int	getValueAtDim(int d)
boolean	isCompatible(int numDims)
int	numDims()
static MatrixOrientation2D	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MatrixOrientation2D[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

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

DIAGONAL

public static final MatrixOrientation2D DIAGONAL

ANTIDIAGONAL

public static final MatrixOrientation2D ANTIDIAGONAL

HORIZONTAL

public static final MatrixOrientation2D HORIZONTAL

VERTICAL

public static final MatrixOrientation2D VERTICAL

Method Detail

values

public static MatrixOrientation2D[] 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 (MatrixOrientation2D c : MatrixOrientation2D.values())
    System.out.println(c);

Returns:

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

valueOf

public static MatrixOrientation2D 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

isCompatible

public boolean isCompatible(int numDims)

Specified by:

isCompatible in interface MatrixOrientation

getByName

public MatrixOrientation getByName(String name)

Specified by:

getByName in interface MatrixOrientation

getValueAtDim

public int getValueAtDim(int d)

Specified by:

getValueAtDim in interface MatrixOrientation

numDims

public int numDims()

Specified by:

numDims in interface MatrixOrientation