Package qupath.lib.images.servers

Enum Class ImageServerMetadata.ChannelType

java.lang.Object

java.lang.Enum<ImageServerMetadata.ChannelType>

qupath.lib.images.servers.ImageServerMetadata.ChannelType

All Implemented Interfaces:

Serializable, Comparable<ImageServerMetadata.ChannelType>, Constable

Enclosing class:

ImageServerMetadata

public static enum ImageServerMetadata.ChannelType
extends Enum<ImageServerMetadata.ChannelType>

Enum representing possible channel (band) types for an image. The purpose of this is to support images where channels have different interpretations, such as probabilities or classifications.

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
CLASSIFICATION	Each channel represents a classification, such as in a labelled image.
DEFAULT	Default channel interpretation.
DENSITY	Each channel represents a density value, such as in a density map (e.g.
FEATURE	Each channel represents a feature for a pixel classifier.
MULTICLASS_PROBABILITY	Each channel represents a probability value, where each pixel is potentially part of multiple classes.
PROBABILITY	Each channel represents a probability value, where it is assumed that there is only one true class per pixel.

Method Summary

Modifier and Type	Method	Description
String	toString()
static ImageServerMetadata.ChannelType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageServerMetadata.ChannelType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final ImageServerMetadata.ChannelType DEFAULT

Default channel interpretation. This is true for most 'normal' images.

FEATURE

public static final ImageServerMetadata.ChannelType FEATURE

Each channel represents a feature for a pixel classifier.

PROBABILITY

public static final ImageServerMetadata.ChannelType PROBABILITY

Each channel represents a probability value, where it is assumed that there is only one true class per pixel.

MULTICLASS_PROBABILITY

public static final ImageServerMetadata.ChannelType MULTICLASS_PROBABILITY

Each channel represents a probability value, where each pixel is potentially part of multiple classes.

CLASSIFICATION

public static final ImageServerMetadata.ChannelType CLASSIFICATION

Each channel represents a classification, such as in a labelled image.

DENSITY

public static final ImageServerMetadata.ChannelType DENSITY

Each channel represents a density value, such as in a density map (e.g. % positive cells).

Method Details

values

public static ImageServerMetadata.ChannelType[] 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 ImageServerMetadata.ChannelType 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

toString

public String toString()

Overrides:

toString in class Enum<ImageServerMetadata.ChannelType>