MatrixOrientation3D (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<MatrixOrientation3D>
- - net.imagej.ops.image.cooccurrenceMatrix.MatrixOrientation3D

All Implemented Interfaces:

Serializable, Comparable<MatrixOrientation3D>, MatrixOrientation
```
public enum MatrixOrientation3D
extends Enum<MatrixOrientation3D>
implements MatrixOrientation
```
Orientation of a CooccurrenceMatrix3D

Author:

Christian Dietz (University of Konstanz)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANTIDIAGONAL`
`ANTIDIAGONAL_DIAGONAL`
`ANTIDIAGONAL_VERTICAL`
`DEPTH`
`DIAGONAL`
`DIAGONAL_DIAGONAL`
`DIAGONAL_VERTICAL`
`HORIZONTAL`
`HORIZONTAL_DIAGONAL`
`HORIZONTAL_VERTICAL`
`VERTICAL`
`VERTICAL_DIAGONAL`
`VERTICAL_VERTICAL`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MatrixOrientation`	`getByName(String name)`
`int`	`getValueAtDim(int d)`
`boolean`	`isCompatible(int numDims)`
`int`	`numDims()`
`static MatrixOrientation3D`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MatrixOrientation3D[]`	`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
  - HORIZONTAL
```
public static final MatrixOrientation3D HORIZONTAL
```
  - VERTICAL
```
public static final MatrixOrientation3D VERTICAL
```
  - DIAGONAL
```
public static final MatrixOrientation3D DIAGONAL
```
  - ANTIDIAGONAL
```
public static final MatrixOrientation3D ANTIDIAGONAL
```
  - HORIZONTAL_VERTICAL
```
public static final MatrixOrientation3D HORIZONTAL_VERTICAL
```
  - HORIZONTAL_DIAGONAL
```
public static final MatrixOrientation3D HORIZONTAL_DIAGONAL
```
  - VERTICAL_VERTICAL
```
public static final MatrixOrientation3D VERTICAL_VERTICAL
```
  - VERTICAL_DIAGONAL
```
public static final MatrixOrientation3D VERTICAL_DIAGONAL
```
  - DIAGONAL_VERTICAL
```
public static final MatrixOrientation3D DIAGONAL_VERTICAL
```
  - DIAGONAL_DIAGONAL
```
public static final MatrixOrientation3D DIAGONAL_DIAGONAL
```
  - ANTIDIAGONAL_VERTICAL
```
public static final MatrixOrientation3D ANTIDIAGONAL_VERTICAL
```
  - ANTIDIAGONAL_DIAGONAL
```
public static final MatrixOrientation3D ANTIDIAGONAL_DIAGONAL
```
  - DEPTH
```
public static final MatrixOrientation3D DEPTH
```
- Method Detail
  - values
```
public static MatrixOrientation3D[] 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 (MatrixOrientation3D c : MatrixOrientation3D.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MatrixOrientation3D 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

Enum MatrixOrientation3D

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

HORIZONTAL

VERTICAL

DIAGONAL

ANTIDIAGONAL

HORIZONTAL_VERTICAL

HORIZONTAL_DIAGONAL

VERTICAL_VERTICAL

VERTICAL_DIAGONAL

DIAGONAL_VERTICAL

DIAGONAL_DIAGONAL

ANTIDIAGONAL_VERTICAL

ANTIDIAGONAL_DIAGONAL

DEPTH

Method Detail

values

valueOf

isCompatible

getByName

getValueAtDim

numDims