Package qupath.lib.objects

package qupath.lib.objects

Provides PathObjects, used to represent annotations and other image structures within QuPath.

There are four main object types in QuPath:

1. Root object, one per image, at the base of the object hierarchy
2. Annotation object, used to represent larger regions, often drawn by hand and used to define regions for analysis
3. TMA core object, similar to annotations but specifically for representing cores within a Tissue Microarray grid
4. Detection object, used to represent objects that may be very numerous (e.g. cell nuclei). There are further specialist subtypes of detection, including cells and tiles.

In general, the idea is that annotations (and TMA cores) should be flexible and editable, whereas detections should be compact and efficient - but typically not editable after creation.

Each object can have a parent and multiple child objects. This means that all objects associated with an image can be found by traversing this hierarchical arrangement, starting from the root object for the image.

Objects also have optional classifications and measurement lists.

Related Packages

Package	Description
qupath.lib.objects.classes	Defines classes to represent classifications for PathObjects.
qupath.lib.objects.hierarchy	Classes to represent the object hierarchy.
qupath.lib.objects.utils	Helper classes for working with PathObjects.

Class	Description
CellTools	Helper class for working with PathObjects that represent cells.
DefaultPathObjectComparator	Default comparator to enable objects to be sorted in a more predictable manner.
DefaultPathObjectConnectionGroup	Simple, default implementation of PathObjectConnectionGroup.
MetadataStore	Interface that may be used to indicate that a PathObject (or other object) can store metadata.
PathAnnotationObject	An annotation PathObject.
PathCellObject	A subclass of a PathDetectionObject, which also supports storing an (optional) extra ROI to represent the cell nucleus.
PathDetectionObject	A detection PathObject.
PathObject	Fundamental object of interest in QuPath.
PathObjectConnectionGroup	Interface defining a basic structure to represent relationships between PathObjects that do not fit with the parent-child idea of the PathObjectHierarchy.
PathObjectConnections	Data structure for storing multiple PathObjectConnectionGroups.
PathObjectFilter	Enumeration of filters (predicates) that can be used to select objects based on their type.
PathObjectPredicates	Classes to define JSON-serializable Predicates for PathObjects.
PathObjectPredicates.PathObjectPredicate	A JSON-serializable Predicate for use with PathObjects.
PathObjectReader	Interface for classes capable of reading PathObjects from some source.
PathObjects	Helper class to create PathObject.
PathObjectTools	A collection of static methods to help work with PathObjects.
PathROIObject	Abstract class used for PathObjects that have ROIs associated with them.
PathRootObject	The root object used at the base of a PathObjectHierarchy.
PathTileObject	A subclass of PathDetectionObject, generally used to represent an image region that doesn't (in itself) correspond to any particularly interesting structure.
TemporaryObject	Marker interface used to indicate that child objects shouldn't be added to any cache for display.
TMACoreObject	A special PathObject used exclusively to represent TMA cores.