ColorClustering.Channel (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<ColorClustering.Channel>
- - trainableSegmentation.unsupervised.ColorClustering.Channel

All Implemented Interfaces:

Serializable, Comparable<ColorClustering.Channel>

Enclosing class:

ColorClustering
```
public static enum ColorClustering.Channel
extends Enum<ColorClustering.Channel>
```
Names of all channels (features) that can be used.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`a` a channel from Lab color space
`b` b channel from Lab color space
`Blue` Blue channel from RGB color space
`Brightness` Brightness channel from HSB color space
`Green` Green channel from RGB color space
`Hue` Hue channel from HSB color space
`Lightness` L channel from Lab color space
`Red` Red channel from RGB color space
`Saturation` Saturation channel from HSB color space

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ColorClustering.Channel`	`fromLabel(String chLabel)` Get channel from label (label is a String).
`static String[]`	`getAllLabels()` Get all labels in a String[] structure.
`static int`	`numChannels()` Returns total number of channels, static method.
`String`	`toString()` Turn channel to string.
`static ColorClustering.Channel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ColorClustering.Channel[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Red
```
public static final ColorClustering.Channel Red
```
    Red channel from RGB color space
  - Green
```
public static final ColorClustering.Channel Green
```
    Green channel from RGB color space
  - Blue
```
public static final ColorClustering.Channel Blue
```
    Blue channel from RGB color space
  - Lightness
```
public static final ColorClustering.Channel Lightness
```
    L channel from Lab color space
  - a
```
public static final ColorClustering.Channel a
```
    a channel from Lab color space
  - b
```
public static final ColorClustering.Channel b
```
    b channel from Lab color space
  - Hue
```
public static final ColorClustering.Channel Hue
```
    Hue channel from HSB color space
  - Saturation
```
public static final ColorClustering.Channel Saturation
```
    Saturation channel from HSB color space
  - Brightness
```
public static final ColorClustering.Channel Brightness
```
    Brightness channel from HSB color space
- Method Detail
  - values
```
public static ColorClustering.Channel[] 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 (ColorClustering.Channel c : ColorClustering.Channel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ColorClustering.Channel 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
  - toString
```
public String toString()
```
    Turn channel to string.
    
    Overrides:
    
    toString in class Enum<ColorClustering.Channel>
    
    Returns:
    
    channel label as a string
  - numChannels
```
public static int numChannels()
```
    Returns total number of channels, static method.
    
    Returns:
    
    number of channels available
  - getAllLabels
```
public static String[] getAllLabels()
```
    Get all labels in a String[] structure.
    
    Returns:
    
    array of channel names
  - fromLabel
```
public static ColorClustering.Channel fromLabel(String chLabel)
```
    Get channel from label (label is a String).
    
    Parameters:
    
    chLabel -
    
    Returns:
    
    channel object specified by input label

Enum ColorClustering.Channel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Red

Green

Blue

Lightness

a

b

Hue

Saturation

Brightness

Method Detail

values

valueOf

toString

numChannels

getAllLabels

fromLabel