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.

See Also:

  • 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

    • UNCLASSIFIED

      public static final PathObjectFilter UNCLASSIFIED
      Accept any object that does not have a classification set

    • CLASSIFIED

      public static final PathObjectFilter CLASSIFIED
      Accept any object that has a classification set (no matter what it is)

  • 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>