Package qupath.lib.objects
Class PathRootObject
java.lang.Object
qupath.lib.objects.PathObject
qupath.lib.objects.PathRootObject
- All Implemented Interfaces:
Externalizable,Serializable,MinimalMetadataStore
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondoubleRequest the classification probability, or Double.NaN if no probability is available.Get the classification of the object.getROI()Get the region of interest (ROI) for the object.booleanThe root object is never locked.booleanReturns true if the object is the 'root' of an object hierarchy.voidsetPathClass(PathClass pathClass, double classProbability) Set the classification of the object, specifying a classification probability.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
-
Constructor Details
-
PathRootObject
public PathRootObject()
-
-
Method Details
-
isRootObject
public boolean isRootObject()Description copied from class:PathObjectReturns true if the object is the 'root' of an object hierarchy.- Overrides:
isRootObjectin classPathObject- Returns:
- See Also:
-
getPathClass
Description copied from class:PathObjectGet the classification of the object.The
PathClassobject 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()andPathObject.getClassifications()provide a simpler way to interact with classifications as one or more strings.- Specified by:
getPathClassin classPathObject- Returns:
- See Also:
-
setPathClass
Description copied from class:PathObjectSet 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:
setPathClassin classPathObject- Parameters:
pathClass-classProbability-- See Also:
-
getClassProbability
public double getClassProbability()Description copied from class:PathObjectRequest the classification probability, or Double.NaN if no probability is available.- Specified by:
getClassProbabilityin classPathObject- Returns:
-
getROI
Description copied from class:PathObjectGet the region of interest (ROI) for the object.- Specified by:
getROIin classPathObject- Returns:
-
toString
- Overrides:
toStringin classPathObject
-
isEditable
public boolean isEditable()The root object is never locked.- Specified by:
isEditablein classPathObject- Returns:
-