Package qupath.lib.classifiers.object

Class ObjectClassifiers.ClassifyByMeasurementBuilder<T>

java.lang.Object

qupath.lib.classifiers.object.ObjectClassifiers.ClassifyByMeasurementBuilder<T>

Type Parameters:

T -

Enclosing class:

ObjectClassifiers

public static class ObjectClassifiers.ClassifyByMeasurementBuilder<T>
extends Object

Builder to create a simple ObjectClassifier that assigns a classification based upon whether the measurement of an object is above, equal to or below a specified threshold.

Constructor Summary

Constructors

Constructor	Description
ClassifyByMeasurementBuilder(String measurementName)	Constructor.

Method Summary

Modifier and Type	Method	Description
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	above(String pathClassName)	Set the classification (by name) for objects for which the specified measurement has a value above the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	above(PathClass pathClass)	Set the classification for objects for which the specified measurement has a value above the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	aboveEquals(String pathClassName)	Set the classification (by name) for objects for which the specified measurement has a value above or equal to the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	aboveEquals(PathClass pathClass)	Set the classification for objects for which the specified measurement has a value above or equal to the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	below(String pathClassName)	Set the classification (by name) for objects for which the specified measurement has a value below the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	below(PathClass pathClass)	Set the classification for objects for which the specified measurement has a value below the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	belowEquals(String pathClassName)	Set the classification (by name) for objects for which the specified measurement has a value below or equal to the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	belowEquals(PathClass pathClass)	Set the classification for objects for which the specified measurement has a value below or equal to the threshold.
ObjectClassifier<T>	build()	Build the classifier defined by the parameters of this builder.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	cells()	Set the filter to accept cell objects only.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	detections()	Set the filter to accept all detection objects only.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	equalTo(String pathClassName)	Set the classification (by name) for objects for which the specified measurement has a value exactly equal to the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	equalTo(PathClass pathClass)	Set the classification for objects for which the specified measurement has a value exactly equal to the threshold.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	filter(PathObjectFilter filter)	Define the filter used to identify objects compatible with this classifier.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	threshold(double threshold)	Set the threshold value used for the classification.
ObjectClassifiers.ClassifyByMeasurementBuilder<T>	tiles()	Set the filter to accept tile objects only.

Methods inherited from class java.lang.Object

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

Constructor Details

ClassifyByMeasurementBuilder

public ClassifyByMeasurementBuilder(String measurementName)

Constructor.

Parameters:

measurementName - name of the measurement used for classification (should be present within the object's MeasurementList).

Method Details

filter

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> filter(PathObjectFilter filter)

Define the filter used to identify objects compatible with this classifier.

Parameters:

filter -

Returns:

this builder

cells

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> cells()

Set the filter to accept cell objects only.

Returns:

this builder

tiles

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> tiles()

Set the filter to accept tile objects only.

Returns:

this builder

detections

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> detections()

Set the filter to accept all detection objects only.

Returns:

this builder

threshold

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> threshold(double threshold)

Set the threshold value used for the classification.

Parameters:

threshold -

Returns:

this builder

above

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> above(String pathClassName)

Set the classification (by name) for objects for which the specified measurement has a value above the threshold.

Parameters:

pathClassName -

Returns:

this builder

See Also:

• threshold(double)

aboveEquals

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> aboveEquals(String pathClassName)

Set the classification (by name) for objects for which the specified measurement has a value above or equal to the threshold.

Parameters:

pathClassName -

Returns:

this builder

See Also:

• threshold(double)

belowEquals

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> belowEquals(String pathClassName)

Set the classification (by name) for objects for which the specified measurement has a value below or equal to the threshold.

Parameters:

pathClassName -

Returns:

this builder

See Also:

• threshold(double)

below

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> below(String pathClassName)

Set the classification (by name) for objects for which the specified measurement has a value below the threshold.

Parameters:

pathClassName -

Returns:

this builder

See Also:

• threshold(double)

equalTo

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> equalTo(String pathClassName)

Set the classification (by name) for objects for which the specified measurement has a value exactly equal to the threshold.

Parameters:

pathClassName -

Returns:

this builder

See Also:

• threshold(double)

above

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> above(PathClass pathClass)

Set the classification for objects for which the specified measurement has a value above the threshold.

Parameters:

pathClass -

Returns:

this builder

See Also:

• threshold(double)

aboveEquals

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> aboveEquals(PathClass pathClass)

Set the classification for objects for which the specified measurement has a value above or equal to the threshold.

Parameters:

pathClass -

Returns:

this builder

See Also:

• threshold(double)

belowEquals

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> belowEquals(PathClass pathClass)

Set the classification for objects for which the specified measurement has a value below or equal to the threshold.

Parameters:

pathClass -

Returns:

this builder

See Also:

• threshold(double)

below

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> below(PathClass pathClass)

Set the classification for objects for which the specified measurement has a value below the threshold.

Parameters:

pathClass -

Returns:

this builder

See Also:

• threshold(double)

equalTo

public ObjectClassifiers.ClassifyByMeasurementBuilder<T> equalTo(PathClass pathClass)

Set the classification for objects for which the specified measurement has a value exactly equal to the threshold.

Parameters:

pathClass -

Returns:

this builder

See Also:

• threshold(double)

build

public ObjectClassifier<T> build()

Build the classifier defined by the parameters of this builder.

Returns:

the object classifier