Package qupath.lib.classifiers.pixel

Class PixelClassifierMetadata

java.lang.Object

qupath.lib.classifiers.pixel.PixelClassifierMetadata

public class PixelClassifierMetadata
extends Object

Metadata to control the behavior of a pixel classifier.

Author:

Pete Bankhead

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PixelClassifierMetadata.Builder	Builder to create PixelClassifierMetadata objects.

Method Summary

Modifier and Type	Method	Description
Map<Integer,PathClass>	getClassificationLabels()	Map between integer labels and classifications.
int	getInputHeight()	Requested height of input image, or -1 if the classifier is not fussy
int	getInputNumChannels()	Requested number of channels in input image; default is 3 (consistent with assuming RGB)
int	getInputPadding()	Requested input padding (above, below, left and right).
PixelCalibration	getInputResolution()	Requested pixel size for input.
int	getInputWidth()	Requested width of input image, or -1 if the classifier is not fussy
List<ImageChannel>	getOutputChannels()	List representing the names & display colors for each output channel, or for the output classifications if outputType == OutputType.Classification
PixelType	getOutputPixelType()	Pixel type of output; default is null indicating the pixel type is unknown.
ImageServerMetadata.ChannelType	getOutputType()	Channel type of output; default is ImageServerMetadata.ChannelType.CLASSIFICATION

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInputResolution

public PixelCalibration getInputResolution()

Requested pixel size for input.

Returns:

getInputPadding

public int getInputPadding()

Requested input padding (above, below, left and right).

Returns:

getInputWidth

public int getInputWidth()

Requested width of input image, or -1 if the classifier is not fussy

Returns:

getInputHeight

public int getInputHeight()

Requested height of input image, or -1 if the classifier is not fussy

Returns:

getInputNumChannels

public int getInputNumChannels()

Requested number of channels in input image; default is 3 (consistent with assuming RGB)

Returns:

getOutputType

public ImageServerMetadata.ChannelType getOutputType()

Channel type of output; default is ImageServerMetadata.ChannelType.CLASSIFICATION

Returns:

getOutputPixelType

public PixelType getOutputPixelType()

Pixel type of output; default is null indicating the pixel type is unknown.

Returns:

getOutputChannels

public List<ImageChannel> getOutputChannels()

List representing the names & display colors for each output channel, or for the output classifications if outputType == OutputType.Classification

Returns:

getClassificationLabels

public Map<Integer,PathClass> getClassificationLabels()

Map between integer labels and classifications. For a labelled image (output type is CLASSIFICATION) then the labels correspond to pixel values. Otherwise they correspond to channel numbers.

Returns: