Package qupath.lib.objects

Class PathDetectionObject

java.lang.Object

qupath.lib.objects.PathObject

qupath.lib.objects.PathROIObject

qupath.lib.objects.PathDetectionObject

All Implemented Interfaces:

Externalizable, Serializable

Direct Known Subclasses:

PathCellObject, PathTileObject

public class PathDetectionObject
extends PathROIObject

A detection PathObject.

Detections tend to be very numerous (e.g. millions of nuclei, each one a detection), and so need to be represented and displayed very efficiently.

Author:

Pete Bankhead

See Also:

• PathAnnotationObject
• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
	PathDetectionObject()	Default constructor.
protected	PathDetectionObject(ROI pathROI, PathClass pathClass)	Create a new PathDetectionObject with a float measurement list.

Method Summary

Modifier and Type	Method	Description
protected MeasurementList	createEmptyMeasurementList()	Default to a simple, float measurement list.
Map<String,String>	getMetadata()	Get a map of metadata values.
boolean	isEditable()	Always returns false - detection objects shouldn't be edited.

Methods inherited from class qupath.lib.objects.PathROIObject

getClassProbability, getPathClass, getROI, isLocked, readExternal, setLocked, setPathClass, setROI, writeExternal

Methods inherited from class qupath.lib.objects.PathObject

addChildObject, addChildObjects, addPathObject, addPathObjects, clearChildObjects, clearMetadataMap, clearPathObjects, getChildObjects, getChildObjects, getChildObjectsAsArray, getClassifications, getColor, getColorRGB, getDescendantObjects, getDisplayedName, getID, getLevel, getMeasurementList, getMeasurements, getName, getParent, getUnmodifiableMetadataMap, hasChildObjects, hasChildren, hasMeasurements, hasROI, isAnnotation, isCell, isDetection, isRootObject, isTile, isTMACore, nChildObjects, nDescendants, objectCountPostfix, refreshID, removeChildObject, removeChildObjects, removePathObject, removePathObjects, resetPathClass, retrieveMetadataKeys, retrieveMetadataValue, setClassifications, setColor, setColor, setColorRGB, setID, setName, setPathClass, storeMetadataValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PathDetectionObject

public PathDetectionObject()

Default constructor. Should not be used directly, instead use PathObjects.createDetectionObject(ROI).

PathDetectionObject

protected PathDetectionObject(ROI pathROI,
 PathClass pathClass)

Create a new PathDetectionObject with a float measurement list.

Parameters:

pathROI -

pathClass -

Method Details

isEditable

public boolean isEditable()

Always returns false - detection objects shouldn't be edited.

Overrides:

isEditable in class PathROIObject

Returns:

createEmptyMeasurementList

protected MeasurementList createEmptyMeasurementList()

Default to a simple, float measurement list.

Overrides:

createEmptyMeasurementList in class PathObject

Returns:

getMetadata

public Map<String,String> getMetadata()

Get a map of metadata values. Note that, for detection objects, this map is unmodifiable to avoid excessive memory use.

Overrides:

getMetadata in class PathObject

Returns:

Since:

v0.5.0