Package qupath.lib.objects

Class PathAnnotationObject

java.lang.Object

qupath.lib.objects.PathObject

qupath.lib.objects.PathROIObject

qupath.lib.objects.PathAnnotationObject

All Implemented Interfaces:

Externalizable, Serializable, MinimalMetadataStore

public class PathAnnotationObject
extends PathROIObject

An annotation PathObject.

These tend to be larger and less common than PathDetectionObjects.

As such, they can be represented and displayed with more emphasis on flexibility, rather than efficiency.

See Also:

• PathDetectionObject
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PathAnnotationObject()	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get a free text description previously set for this annotation.
void	setDescription(String text)	Set a free text description for this annotation.

Methods inherited from class qupath.lib.objects.PathROIObject

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

Methods inherited from class qupath.lib.objects.PathObject

addChildObject, addChildObjects, clearChildObjects, clearMetadataMap, createEmptyMeasurementList, getChildObjects, getChildObjects, getChildObjectsAsArray, getClassification, getClassifications, getColor, getDescendantObjects, getDisplayedName, getID, getLevel, getMeasurementList, getMeasurements, getMetadata, getName, getParent, getUnmodifiableMetadataMap, hasChildObjects, hasMeasurements, hasMetadata, hasROI, isAnnotation, isCell, isDetection, isRootObject, isTile, isTMACore, nChildObjects, nDescendants, objectCountPostfix, refreshID, removeChildObject, removeChildObjects, resetPathClass, retrieveMetadataKeys, retrieveMetadataValue, setClassification, setClassification, setClassifications, setColor, setColor, setID, setName, setPathClass, storeMetadataValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PathAnnotationObject

public PathAnnotationObject()

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

Method Details

setDescription

public void setDescription(String text)

Set a free text description for this annotation.

Parameters:

text - to use as a description; if null, any existing description will be removed

getDescription

public String getDescription()

Get a free text description previously set for this annotation.

Returns: