Package qupath.lib.gui.viewer

Enum Class RegionFilter.StandardRegionFilters

java.lang.Object

java.lang.Enum<RegionFilter.StandardRegionFilters>

qupath.lib.gui.viewer.RegionFilter.StandardRegionFilters

All Implemented Interfaces:

Serializable, Comparable<RegionFilter.StandardRegionFilters>, Constable, BiPredicate<ImageData<?>,RegionRequest>, RegionFilter

Enclosing interface:

RegionFilter

public static enum RegionFilter.StandardRegionFilters
extends Enum<RegionFilter.StandardRegionFilters>
implements RegionFilter

Standard classification regions (hopefully all you will ever need).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface qupath.lib.gui.viewer.RegionFilter

RegionFilter.StandardRegionFilters

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY_ANNOTATIONS	Regions overlapping the ROIs of any annotations
ANY_ANNOTATIONS_BOUNDS	Regions overlapping the bounding box of any annotations
ANY_OBJECTS	Regions overlapping the ROIs of any objects
ANY_OBJECTS_BOUNDS	Regions overlapping the bounding box of any objects
EVERYWHERE	Accept all requests
IMAGE	Accept all requests for the image where the region is non-empty

Method Summary

Modifier and Type	Method	Description
boolean	test(ImageData<?> imageData, RegionRequest region)
String	toString()
static RegionFilter.StandardRegionFilters	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RegionFilter.StandardRegionFilters[]	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.BiPredicate

and, negate, or

Enum Constant Details

EVERYWHERE

public static final RegionFilter.StandardRegionFilters EVERYWHERE

Accept all requests

ANY_OBJECTS

public static final RegionFilter.StandardRegionFilters ANY_OBJECTS

Regions overlapping the ROIs of any objects

ANY_ANNOTATIONS

public static final RegionFilter.StandardRegionFilters ANY_ANNOTATIONS

Regions overlapping the ROIs of any annotations

ANY_OBJECTS_BOUNDS

public static final RegionFilter.StandardRegionFilters ANY_OBJECTS_BOUNDS

Regions overlapping the bounding box of any objects

ANY_ANNOTATIONS_BOUNDS

public static final RegionFilter.StandardRegionFilters ANY_ANNOTATIONS_BOUNDS

Regions overlapping the bounding box of any annotations

IMAGE

public static final RegionFilter.StandardRegionFilters IMAGE

Accept all requests for the image where the region is non-empty

Method Details

values

public static RegionFilter.StandardRegionFilters[] 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 RegionFilter.StandardRegionFilters 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<RegionFilter.StandardRegionFilters>

test

public boolean test(ImageData<?> imageData,
 RegionRequest region)

Specified by:

test in interface BiPredicate<ImageData<?>,RegionRequest>