Package qupath.lib.objects

Enum Class PathObjectFilter

java.lang.Object

java.lang.Enum<PathObjectFilter>

qupath.lib.objects.PathObjectFilter

All Implemented Interfaces:

Serializable, Comparable<PathObjectFilter>, Constable, Predicate<PathObject>

public enum PathObjectFilter
extends Enum<PathObjectFilter>
implements Predicate<PathObject>

Enumeration of filters (predicates) that can be used to select objects based on their type.

See also PathObjectPredicates for more complex JSON-serializable predicates.

Author:

Pete Bankhead

See Also:

• PathObjectPredicates

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
ANNOTATIONS	Accept annotation objects
CELLS	Accept cells
DETECTIONS	Accept detection objects (no subtypes, e.g.
DETECTIONS_ALL	Accept detection objects (all subtypes)
ROI	Accept any object that has a ROI
ROI_AREA	Accept any object that has an area ROI
ROI_LINE	Accept any object that has a line ROI
ROI_POINT	Accept any object that has a points ROI
TILES	Accept tiles
TMA_CORES	Accept TMA cores
UNLOCKED	Accept any object that is 'unlocked'

Method Summary

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Enum Constant Details

ANNOTATIONS

public static final PathObjectFilter ANNOTATIONS

Accept annotation objects

DETECTIONS

public static final PathObjectFilter DETECTIONS

Accept detection objects (no subtypes, e.g. cells)

DETECTIONS_ALL

public static final PathObjectFilter DETECTIONS_ALL

Accept detection objects (all subtypes)

CELLS

public static final PathObjectFilter CELLS

Accept cells

TILES

public static final PathObjectFilter TILES

Accept tiles

TMA_CORES

public static final PathObjectFilter TMA_CORES

Accept TMA cores

UNLOCKED

public static final PathObjectFilter UNLOCKED

Accept any object that is 'unlocked'

ROI

public static final PathObjectFilter ROI

Accept any object that has a ROI

ROI_LINE

public static final PathObjectFilter ROI_LINE

Accept any object that has a line ROI

ROI_AREA

public static final PathObjectFilter ROI_AREA

Accept any object that has an area ROI

ROI_POINT

public static final PathObjectFilter ROI_POINT

Accept any object that has a points ROI

Method Details

values

public static PathObjectFilter[] 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 PathObjectFilter 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<PathObjectFilter>

test

public boolean test(PathObject p)

Specified by:

test in interface Predicate<PathObject>