Package qupath.opencv.ml

Class PatchClassifierParams.Builder

java.lang.Object

qupath.opencv.ml.PatchClassifierParams.Builder

Enclosing class:

PatchClassifierParams

public static class PatchClassifierParams.Builder
extends Object

Builder class to create PatchClassifierParams.

Method Summary

Modifier and Type	Method	Description
PatchClassifierParams	build()	Build the patch classifier parameters.
PatchClassifierParams.Builder	halo(int padding)	Define a halo that is symmetric in x and y.
PatchClassifierParams.Builder	halo(Padding halo)	Define a halo using a padding object.
PatchClassifierParams.Builder	inputChannels(int... channels)	Define the input channels using (zero-based) channel numbers.
PatchClassifierParams.Builder	inputChannels(String... channels)	Define the input channels using channel names.
PatchClassifierParams.Builder	inputChannels(Collection<? extends ColorTransforms.ColorTransform> channels)	Define the input channels from a collection of color transforms.
PatchClassifierParams.Builder	inputResolution(PixelCalibration cal)	Define the input resolution using a pixel calibration object.
PatchClassifierParams.Builder	inputResolution(PixelCalibration cal, double downsample)	Define the input resolution using a pixel calibration and a scaling factor.
PatchClassifierParams.Builder	outputChannelType(ImageServerMetadata.ChannelType channelType)	Define the channel type for the output.
PatchClassifierParams.Builder	outputClasses(Map<Integer,PathClass> outputClasses)	Define the classifications for the output as a map.
PatchClassifierParams.Builder	outputClasses(PathClass... outputClasses)	Define the classifications for the output as an array.
PatchClassifierParams.Builder	outputClassNames(String... outputClasses)	Define the classifications for the output as an array of classification names.
PatchClassifierParams.Builder	outputClassNames(Map<Integer,String> outputClasses)	Define the classifications for the output as a map with string values.
PatchClassifierParams.Builder	patchSize(int patchSize)	Define the requested square patch size.
PatchClassifierParams.Builder	patchSize(int patchWidth, int patchHeight)	Define the requested patch size.
PatchClassifierParams.Builder	postprocessing(Collection<? extends ImageOp> postprocessingOps)	Define the postprocessing steps from a collection.
PatchClassifierParams.Builder	postprocessing(ImageOp... postprocessingOps)	Define the postprocessing steps from an array.
PatchClassifierParams.Builder	prediction(DnnModel model, Padding padding, String... outputNames)	Define the DNN to be used for prediction, to be applied after preprocessing and before postprocessing.
PatchClassifierParams.Builder	prediction(ImageOp predictionOp)	Define the prediction image op, to be applied after preprocessing and before postprocessing.
PatchClassifierParams.Builder	preprocessing(Collection<? extends ImageOp> preprocessingOps)	Define the preprocessing steps from a collection.
PatchClassifierParams.Builder	preprocessing(ImageOp... preprocessingOps)	Define the preprocessing steps from an array.

Methods inherited from class java.lang.Object

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

Method Details

inputChannels

public PatchClassifierParams.Builder inputChannels(String... channels)

Define the input channels using channel names.

Parameters:

channels -

Returns:

See Also:

• inputChannels(int...)

inputChannels

public PatchClassifierParams.Builder inputChannels(int... channels)

Define the input channels using (zero-based) channel numbers.

Parameters:

channels -

Returns:

See Also:

• inputChannels(String...)

inputChannels

public PatchClassifierParams.Builder inputChannels(Collection<? extends ColorTransforms.ColorTransform> channels)

Define the input channels from a collection of color transforms. An ordered collection (e.g. list) should be used, since the iteration order is important.

Parameters:

channels -

Returns:

inputResolution

public PatchClassifierParams.Builder inputResolution(PixelCalibration cal,
 double downsample)

Define the input resolution using a pixel calibration and a scaling factor.

Parameters:

cal - input calibration; if null, a default calibration will be used

downsample - scaling factor (1.0 to use the calibration directly)

Returns:

inputResolution

public PatchClassifierParams.Builder inputResolution(PixelCalibration cal)

Define the input resolution using a pixel calibration object.

Parameters:

cal -

Returns:

halo

public PatchClassifierParams.Builder halo(int padding)

Define a halo that is symmetric in x and y.

Parameters:

padding - padding value, to be added both before and after rows and columns.

Returns:

See Also:

• halo(Padding)

halo

public PatchClassifierParams.Builder halo(Padding halo)

Define a halo using a padding object.

Parameters:

halo -

Returns:

See Also:

• halo(int)

patchSize

public PatchClassifierParams.Builder patchSize(int patchSize)

Define the requested square patch size.

Parameters:

patchSize - width and height of the patch

Returns:

patchSize

public PatchClassifierParams.Builder patchSize(int patchWidth,
 int patchHeight)

Define the requested patch size.

Parameters:

patchWidth - requested patch width

patchHeight - requested patch height

Returns:

preprocessing

public PatchClassifierParams.Builder preprocessing(ImageOp... preprocessingOps)

Define the preprocessing steps from an array. Note that any existing preprocessing steps in the builder will be replaced by those provided here.

Parameters:

preprocessingOps -

Returns:

preprocessing

public PatchClassifierParams.Builder preprocessing(Collection<? extends ImageOp> preprocessingOps)

Define the preprocessing steps from a collection. Note that any existing preprocessing steps in the builder will be replaced by those provided here.

Parameters:

preprocessingOps -

Returns:

prediction

public PatchClassifierParams.Builder prediction(ImageOp predictionOp)

Define the prediction image op, to be applied after preprocessing and before postprocessing.

Parameters:

predictionOp -

Returns:

See Also:

• prediction(DnnModel, Padding, String...)

prediction

public PatchClassifierParams.Builder prediction(DnnModel model,
 Padding padding,
 String... outputNames)

Define the DNN to be used for prediction, to be applied after preprocessing and before postprocessing.

Parameters:

model -

padding -

outputNames -

Returns:

See Also:

• prediction(ImageOp)

postprocessing

public PatchClassifierParams.Builder postprocessing(ImageOp... postprocessingOps)

Define the postprocessing steps from an array. Note that any existing postprocessing steps in the builder will be replaced by those provided here.

Parameters:

postprocessingOps -

Returns:

postprocessing

public PatchClassifierParams.Builder postprocessing(Collection<? extends ImageOp> postprocessingOps)

Define the postprocessing steps from a collection. Note that any existing postprocessing steps in the builder will be replaced by those provided here.

Parameters:

postprocessingOps -

Returns:

outputChannelType

public PatchClassifierParams.Builder outputChannelType(ImageServerMetadata.ChannelType channelType)

Define the channel type for the output.

Parameters:

channelType -

Returns:

outputClasses

public PatchClassifierParams.Builder outputClasses(Map<Integer,PathClass> outputClasses)

Define the classifications for the output as a map.

Parameters:

outputClasses -

Returns:

See Also:

• outputClassNames(Map)
• outputClasses(PathClass...)
• outputClassNames(String...)

outputClasses

public PatchClassifierParams.Builder outputClasses(PathClass... outputClasses)

Define the classifications for the output as an array.

Parameters:

outputClasses -

Returns:

See Also:

• outputClasses(Map)
• outputClassNames(Map)
• outputClassNames(String...)

outputClassNames

public PatchClassifierParams.Builder outputClassNames(String... outputClasses)

Define the classifications for the output as an array of classification names.

Parameters:

outputClasses -

Returns:

See Also:

• outputClasses(PathClass...)
• outputClassNames(String...)

outputClassNames

public PatchClassifierParams.Builder outputClassNames(Map<Integer,String> outputClasses)

Define the classifications for the output as a map with string values.

Parameters:

outputClasses -

Returns:

See Also:

• outputClasses(Map)
• outputClasses(PathClass...)
• outputClassNames(String...)

build

public PatchClassifierParams build()

Build the patch classifier parameters.

Returns: