Package biopb.image

Interface RoiAnnotationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RoiAnnotation, RoiAnnotation.Builder
public interface RoiAnnotationOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsPlane(int key)
    map<uint32, uint32> plane = 12;
    String
    getArrayId()
    The tensor this annotation is drawn on: the globally-unique array_id, in its UNVERSIONED form (never the sidecar's `source@token/field`).
    com.google.protobuf.ByteString
    getArrayIdBytes()
    The tensor this annotation is drawn on: the globally-unique array_id, in its UNVERSIONED form (never the sidecar's `source@token/field`).
    long
    getCreatedAtUnixMs()
    int64 created_at_unix_ms = 10;
    com.google.protobuf.ByteString
    getDrawnAgainstVersion()
    The tensor's content_version when this annotation was written, or unset when the source could not claim one.
    String
    getLabel()
    User-facing class/name for this ROI.
    com.google.protobuf.ByteString
    getLabelBytes()
    User-facing class/name for this ROI.
    Map<Integer,Integer>
    getPlane()
    Deprecated.
    int
    getPlaneCount()
    map<uint32, uint32> plane = 12;
    Map<Integer,Integer>
    getPlaneMap()
    map<uint32, uint32> plane = 12;
    int
    getPlaneOrDefault(int key, int defaultValue)
    map<uint32, uint32> plane = 12;
    int
    getPlaneOrThrow(int key)
    map<uint32, uint32> plane = 12;
    String
    getPropsJson()
    Free-form client JSON (colour, score, author, ...).
    com.google.protobuf.ByteString
    getPropsJsonBytes()
    Free-form client JSON (colour, score, author, ...).
    long
    getRev()
    Server-assigned, bumped on every write.
    ROI
    getRoi()
    Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes.
    String
    getRoiId()
    Stable id.
    com.google.protobuf.ByteString
    getRoiIdBytes()
    Stable id.
    ROIOrBuilder
    getRoiOrBuilder()
    Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes.
    String
    getSetName()
    Grouping key -- the "layer" an annotation belongs to (e.g.
    com.google.protobuf.ByteString
    getSetNameBytes()
    Grouping key -- the "layer" an annotation belongs to (e.g.
    long
    getUpdatedAtUnixMs()
    int64 updated_at_unix_ms = 11;
    boolean
    hasDrawnAgainstVersion()
    The tensor's content_version when this annotation was written, or unset when the source could not claim one.
    boolean
    hasRoi()
    Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getRoiId

      String getRoiId()
       Stable id. Empty on create -> the server mints a uuid4 hex.
      string roi_id = 1;
      Returns:
      The roiId.

    • getRoiIdBytes

      com.google.protobuf.ByteString getRoiIdBytes()
       Stable id. Empty on create -> the server mints a uuid4 hex.
      string roi_id = 1;
      Returns:
      The bytes for roiId.

    • getArrayId

      String getArrayId()
       The tensor this annotation is drawn on: the globally-unique array_id, in its
 UNVERSIONED form (never the sidecar's `source@token/field`). Annotations
 must outlive an in-place edit of the image, so the version token is stripped
 before it reaches the store.
      string array_id = 2;
      Returns:
      The arrayId.

    • getArrayIdBytes

      com.google.protobuf.ByteString getArrayIdBytes()
       The tensor this annotation is drawn on: the globally-unique array_id, in its
 UNVERSIONED form (never the sidecar's `source@token/field`). Annotations
 must outlive an in-place edit of the image, so the version token is stripped
 before it reaches the store.
      string array_id = 2;
      Returns:
      The bytes for arrayId.

    • getSetName

      String getSetName()
       Grouping key -- the "layer" an annotation belongs to (e.g. "nuclei").
 Empty -> "default".
      string set_name = 3;
      Returns:
      The setName.

    • getSetNameBytes

      com.google.protobuf.ByteString getSetNameBytes()
       Grouping key -- the "layer" an annotation belongs to (e.g. "nuclei").
 Empty -> "default".
      string set_name = 3;
      Returns:
      The bytes for setName.

    • getLabel

      String getLabel()
       User-facing class/name for this ROI.
      string label = 4;
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
       User-facing class/name for this ROI.
      string label = 4;
      Returns:
      The bytes for label.

    • hasRoi

      boolean hasRoi()
       Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes. A shape
 drawn on a downsampled level is scaled up by the client; the server never
 rescales geometry.
      .biopb.image.ROI roi = 5;
      Returns:
      Whether the roi field is set.

    • getRoi

      ROI getRoi()
       Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes. A shape
 drawn on a downsampled level is scaled up by the client; the server never
 rescales geometry.
      .biopb.image.ROI roi = 5;
      Returns:
      The roi.

    • getRoiOrBuilder

      ROIOrBuilder getRoiOrBuilder()
       Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes. A shape
 drawn on a downsampled level is scaled up by the client; the server never
 rescales geometry.
      .biopb.image.ROI roi = 5;

    • getPlaneCount

      int getPlaneCount()
      map<uint32, uint32> plane = 12;

    • containsPlane

      boolean containsPlane(int key)
      map<uint32, uint32> plane = 12;

    • getPlane

      @Deprecated Map<Integer,Integer> getPlane()
      Deprecated.
      Use getPlaneMap() instead.

    • getPlaneMap

      Map<Integer,Integer> getPlaneMap()
      map<uint32, uint32> plane = 12;

    • getPlaneOrDefault

      int getPlaneOrDefault(int key, int defaultValue)
      map<uint32, uint32> plane = 12;

    • getPlaneOrThrow

      int getPlaneOrThrow(int key)
      map<uint32, uint32> plane = 12;

    • getPropsJson

      String getPropsJson()
       Free-form client JSON (colour, score, author, ...). Opaque to the server.
      string props_json = 7;
      Returns:
      The propsJson.

    • getPropsJsonBytes

      com.google.protobuf.ByteString getPropsJsonBytes()
       Free-form client JSON (colour, score, author, ...). Opaque to the server.
      string props_json = 7;
      Returns:
      The bytes for propsJson.

    • hasDrawnAgainstVersion

      boolean hasDrawnAgainstVersion()
       The tensor's content_version when this annotation was written, or unset when
 the source could not claim one. A client compares it against the current
 descriptor to warn "the image changed since this was drawn" -- CONTENT
 staleness, as distinct from the tensor going away entirely.
      optional bytes drawn_against_version = 8;
      Returns:
      Whether the drawnAgainstVersion field is set.

    • getDrawnAgainstVersion

      com.google.protobuf.ByteString getDrawnAgainstVersion()
       The tensor's content_version when this annotation was written, or unset when
 the source could not claim one. A client compares it against the current
 descriptor to warn "the image changed since this was drawn" -- CONTENT
 staleness, as distinct from the tensor going away entirely.
      optional bytes drawn_against_version = 8;
      Returns:
      The drawnAgainstVersion.

    • getRev

      long getRev()
       Server-assigned, bumped on every write. Echo the value you read back in a
 put with check_rev set to make the write conditional.
      int64 rev = 9;
      Returns:
      The rev.

    • getCreatedAtUnixMs

      long getCreatedAtUnixMs()
      int64 created_at_unix_ms = 10;
      Returns:
      The createdAtUnixMs.

    • getUpdatedAtUnixMs

      long getUpdatedAtUnixMs()
      int64 updated_at_unix_ms = 11;
      Returns:
      The updatedAtUnixMs.