Package qupath.lib.objects

Class PathRootObject

java.lang.Object

qupath.lib.objects.PathObject

qupath.lib.objects.PathRootObject

All Implemented Interfaces:

Externalizable, Serializable, MinimalMetadataStore

public class PathRootObject
extends PathObject

The root object used at the base of a PathObjectHierarchy.

This doesn't have a ROI, and can't have its PathClass set.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PathRootObject()

Method Summary

Modifier and Type	Method	Description
double	getClassProbability()	Request the classification probability, or Double.NaN if no probability is available.
PathClass	getPathClass()	Get the classification of the object.
ROI	getROI()	Get the region of interest (ROI) for the object.
boolean	isEditable()	The root object is never locked.
boolean	isRootObject()	Returns true if the object is the 'root' of an object hierarchy.
void	setPathClass(PathClass pathClass, double classProbability)	Set the classification of the object, specifying a classification probability.
String	toString()

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, isLocked, isTile, isTMACore, nChildObjects, nDescendants, objectCountPostfix, readExternal, refreshID, removeChildObject, removeChildObjects, resetPathClass, retrieveMetadataKeys, retrieveMetadataValue, setClassification, setClassification, setClassifications, setColor, setColor, setID, setLocked, setName, setPathClass, storeMetadataValue, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Details

PathRootObject

public PathRootObject()

Method Details

isRootObject

public boolean isRootObject()

Description copied from class: PathObject

Returns true if the object is the 'root' of an object hierarchy.

Overrides:

isRootObject in class PathObject

Returns:

See Also:

• PathObjectHierarchy

getPathClass

public PathClass getPathClass()

Description copied from class: PathObject

Get the classification of the object.

The PathClass object is used as the internal representation of the object's classification, encapsulating both the different string components of the classification and the color used for display.

For convenience, PathObject.getClassification() and PathObject.getClassifications() provide a simpler way to interact with classifications as one or more strings.

Specified by:

getPathClass in class PathObject

Returns:

See Also:

• PathObject.setPathClass(PathClass)
• PathObject.getClassification()
• PathObject.getClassifications()

setPathClass

public void setPathClass(PathClass pathClass,
 double classProbability)

Description copied from class: PathObject

Set the classification of the object, specifying a classification probability.

The probability is expected to be between 0 and 1, or Double.NaN if no probability should be set.

Specified by:

setPathClass in class PathObject

Parameters:

pathClass -

classProbability -

See Also:

• PathObject.setPathClass(PathClass)
• PathObject.setClassification(String)
• PathObject.setClassifications(Collection)

getClassProbability

public double getClassProbability()

Description copied from class: PathObject

Request the classification probability, or Double.NaN if no probability is available.

Specified by:

getClassProbability in class PathObject

Returns:

getROI

public ROI getROI()

Description copied from class: PathObject

Get the region of interest (ROI) for the object.

Specified by:

getROI in class PathObject

Returns:

toString

public String toString()

Overrides:

toString in class PathObject

isEditable

public boolean isEditable()

The root object is never locked.

Specified by:

isEditable in class PathObject

Returns: