Package qupath.lib.objects

Class PathObjectPredicates

java.lang.Object

qupath.lib.objects.PathObjectPredicates

public class PathObjectPredicates
extends Object

Classes to define JSON-serializable Predicates for PathObjects.

Author:

Pete Bankhead

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PathObjectPredicates.PathObjectPredicate	A JSON-serializable Predicate for use with PathObjects.

Constructor Summary

Constructors

Constructor	Description
PathObjectPredicates()

Method Summary

Modifier and Type	Method	Description
static PathObjectPredicates.PathObjectPredicate	baseClassification(PathClass... pathClasses)	Predicate that returns true if an object has any of the specified base classifications, regardless of any subclassification.
static PathObjectPredicates.PathObjectPredicate	containsClassification(String... names)	Predicate that returns true if any component of its classification has any of the specified names.
static PathObjectPredicates.PathObjectPredicate	exactClassification(PathClass... pathClasses)	Predicate that returns true if a PathObject has at least one of the specified PathClasses.
static PathObjectPredicates.PathObjectPredicate	filter(PathObjectFilter filter)	Wrap a PathObjectFilter as a PathObjectPredicates.PathObjectPredicate so that it can remain JSON-serializable when used in combination with other predicates.
static PathObjectPredicates.PathObjectPredicate	positiveClassification(boolean allowGradedIntensity)	Predicate that returns true of an object has a positive classification.

Methods inherited from class java.lang.Object

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

Constructor Details

PathObjectPredicates

public PathObjectPredicates()

Method Details

positiveClassification

public static PathObjectPredicates.PathObjectPredicate positiveClassification(boolean allowGradedIntensity)

Predicate that returns true of an object has a positive classification.

Parameters:

allowGradedIntensity - if true, 1+, 2+ and 3+ are also interpreted as positive; otherwise, only a final class component of "Positive" returns true.

Returns:

See Also:

• PathClassTools.isPositiveClass(PathClass)
• PathClassTools.isGradedIntensityClass(PathClass)
• PathClassTools.isPositiveOrGradedIntensityClass(PathClass)

filter

public static PathObjectPredicates.PathObjectPredicate filter(PathObjectFilter filter)

Wrap a PathObjectFilter as a PathObjectPredicates.PathObjectPredicate so that it can remain JSON-serializable when used in combination with other predicates.

Parameters:

filter -

Returns:

exactClassification

public static PathObjectPredicates.PathObjectPredicate exactClassification(PathClass... pathClasses)

Predicate that returns true if a PathObject has at least one of the specified PathClasses.

Parameters:

pathClasses - list of acceptable classifications; must be greater than 0.

Returns:

containsClassification

public static PathObjectPredicates.PathObjectPredicate containsClassification(String... names)

Predicate that returns true if any component of its classification has any of the specified names.

Parameters:

names -

Returns:

See Also:

• PathClassTools.containsName(PathClass, String)

baseClassification

public static PathObjectPredicates.PathObjectPredicate baseClassification(PathClass... pathClasses)

Predicate that returns true if an object has any of the specified base classifications, regardless of any subclassification.

Parameters:

pathClasses -

Returns:

See Also:

• PathClass.getBaseClass()