Package biopb.image

Class RoiAnnotation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

biopb.image.RoiAnnotation

All Implemented Interfaces:

RoiAnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RoiAnnotation
extends com.google.protobuf.GeneratedMessageV3
implements RoiAnnotationOrBuilder

 One annotation: a geometry, where it sits, and what the user called it.
 

Protobuf type biopb.image.RoiAnnotation

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RoiAnnotation.Builder	One annotation: a geometry, where it sits, and what the user called it.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ARRAY_ID_FIELD_NUMBER
static final int	CREATED_AT_UNIX_MS_FIELD_NUMBER
static final int	DRAWN_AGAINST_VERSION_FIELD_NUMBER
static final int	LABEL_FIELD_NUMBER
static final int	PLANE_FIELD_NUMBER
static final int	PROPS_JSON_FIELD_NUMBER
static final int	REV_FIELD_NUMBER
static final int	ROI_FIELD_NUMBER
static final int	ROI_ID_FIELD_NUMBER
static final int	SET_NAME_FIELD_NUMBER
static final int	UPDATED_AT_UNIX_MS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	containsPlane(int key)	map<uint32, uint32> plane = 12;
boolean	equals(Object obj)
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;
static RoiAnnotation	getDefaultInstance()
RoiAnnotation	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<RoiAnnotation>	getParserForType()
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.
int	getSerializedSize()
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.
int	hashCode()
boolean	hasRoi()	Geometry in LEVEL-0 pixel coordinates, in the tensor's own Y/X axes.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
final boolean	isInitialized()
static RoiAnnotation.Builder	newBuilder()
static RoiAnnotation.Builder	newBuilder(RoiAnnotation prototype)
RoiAnnotation.Builder	newBuilderForType()
protected RoiAnnotation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RoiAnnotation	parseDelimitedFrom(InputStream input)
static RoiAnnotation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoiAnnotation	parseFrom(byte[] data)
static RoiAnnotation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoiAnnotation	parseFrom(com.google.protobuf.ByteString data)
static RoiAnnotation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoiAnnotation	parseFrom(com.google.protobuf.CodedInputStream input)
static RoiAnnotation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoiAnnotation	parseFrom(InputStream input)
static RoiAnnotation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RoiAnnotation	parseFrom(ByteBuffer data)
static RoiAnnotation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RoiAnnotation>	parser()
RoiAnnotation.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

ROI_ID_FIELD_NUMBER

public static final int ROI_ID_FIELD_NUMBER

See Also:

• Constant Field Values

ARRAY_ID_FIELD_NUMBER

public static final int ARRAY_ID_FIELD_NUMBER

See Also:

• Constant Field Values

SET_NAME_FIELD_NUMBER

public static final int SET_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

See Also:

• Constant Field Values

ROI_FIELD_NUMBER

public static final int ROI_FIELD_NUMBER

See Also:

• Constant Field Values

PLANE_FIELD_NUMBER

public static final int PLANE_FIELD_NUMBER

See Also:

• Constant Field Values

PROPS_JSON_FIELD_NUMBER

public static final int PROPS_JSON_FIELD_NUMBER

See Also:

• Constant Field Values

DRAWN_AGAINST_VERSION_FIELD_NUMBER

public static final int DRAWN_AGAINST_VERSION_FIELD_NUMBER

See Also:

• Constant Field Values

REV_FIELD_NUMBER

public static final int REV_FIELD_NUMBER

See Also:

• Constant Field Values

CREATED_AT_UNIX_MS_FIELD_NUMBER

public static final int CREATED_AT_UNIX_MS_FIELD_NUMBER

See Also:

• Constant Field Values

UPDATED_AT_UNIX_MS_FIELD_NUMBER

public static final int UPDATED_AT_UNIX_MS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRoiId

public String getRoiId()

 Stable id. Empty on create -> the server mints a uuid4 hex.
 

string roi_id = 1;

Specified by:

getRoiId in interface RoiAnnotationOrBuilder

Returns:

The roiId.

getRoiIdBytes

public com.google.protobuf.ByteString getRoiIdBytes()

 Stable id. Empty on create -> the server mints a uuid4 hex.
 

string roi_id = 1;

Specified by:

getRoiIdBytes in interface RoiAnnotationOrBuilder

Returns:

The bytes for roiId.

getArrayId

public 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;

Specified by:

getArrayId in interface RoiAnnotationOrBuilder

Returns:

The arrayId.

getArrayIdBytes

public 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;

Specified by:

getArrayIdBytes in interface RoiAnnotationOrBuilder

Returns:

The bytes for arrayId.

getSetName

public String getSetName()

 Grouping key -- the "layer" an annotation belongs to (e.g. "nuclei").
 Empty -> "default".
 

string set_name = 3;

Specified by:

getSetName in interface RoiAnnotationOrBuilder

Returns:

The setName.

getSetNameBytes

public com.google.protobuf.ByteString getSetNameBytes()

 Grouping key -- the "layer" an annotation belongs to (e.g. "nuclei").
 Empty -> "default".
 

string set_name = 3;

Specified by:

getSetNameBytes in interface RoiAnnotationOrBuilder

Returns:

The bytes for setName.

getLabel

public String getLabel()

 User-facing class/name for this ROI.
 

string label = 4;

Specified by:

getLabel in interface RoiAnnotationOrBuilder

Returns:

The label.

getLabelBytes

public com.google.protobuf.ByteString getLabelBytes()

 User-facing class/name for this ROI.
 

string label = 4;

Specified by:

getLabelBytes in interface RoiAnnotationOrBuilder

Returns:

The bytes for label.

hasRoi

public 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;

Specified by:

hasRoi in interface RoiAnnotationOrBuilder

Returns:

Whether the roi field is set.

getRoi

public 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;

Specified by:

getRoi in interface RoiAnnotationOrBuilder

Returns:

The roi.

getRoiOrBuilder

public 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;

Specified by:

getRoiOrBuilder in interface RoiAnnotationOrBuilder

getPlaneCount

public int getPlaneCount()

Description copied from interface: RoiAnnotationOrBuilder

map<uint32, uint32> plane = 12;

Specified by:

getPlaneCount in interface RoiAnnotationOrBuilder

containsPlane

public boolean containsPlane(int key)

map<uint32, uint32> plane = 12;

Specified by:

containsPlane in interface RoiAnnotationOrBuilder

getPlane

@Deprecated
public Map<Integer,Integer> getPlane()

Deprecated.

Use getPlaneMap() instead.

Specified by:

getPlane in interface RoiAnnotationOrBuilder

getPlaneMap

public Map<Integer,Integer> getPlaneMap()

map<uint32, uint32> plane = 12;

Specified by:

getPlaneMap in interface RoiAnnotationOrBuilder

getPlaneOrDefault

public int getPlaneOrDefault(int key,
 int defaultValue)

map<uint32, uint32> plane = 12;

Specified by:

getPlaneOrDefault in interface RoiAnnotationOrBuilder

getPlaneOrThrow

public int getPlaneOrThrow(int key)

map<uint32, uint32> plane = 12;

Specified by:

getPlaneOrThrow in interface RoiAnnotationOrBuilder

getPropsJson

public String getPropsJson()

 Free-form client JSON (colour, score, author, ...). Opaque to the server.
 

string props_json = 7;

Specified by:

getPropsJson in interface RoiAnnotationOrBuilder

Returns:

The propsJson.

getPropsJsonBytes

public com.google.protobuf.ByteString getPropsJsonBytes()

 Free-form client JSON (colour, score, author, ...). Opaque to the server.
 

string props_json = 7;

Specified by:

getPropsJsonBytes in interface RoiAnnotationOrBuilder

Returns:

The bytes for propsJson.

hasDrawnAgainstVersion

public 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;

Specified by:

hasDrawnAgainstVersion in interface RoiAnnotationOrBuilder

Returns:

Whether the drawnAgainstVersion field is set.

getDrawnAgainstVersion

public 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;

Specified by:

getDrawnAgainstVersion in interface RoiAnnotationOrBuilder

Returns:

The drawnAgainstVersion.

getRev

public 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;

Specified by:

getRev in interface RoiAnnotationOrBuilder

Returns:

The rev.

getCreatedAtUnixMs

public long getCreatedAtUnixMs()

int64 created_at_unix_ms = 10;

Specified by:

getCreatedAtUnixMs in interface RoiAnnotationOrBuilder

Returns:

The createdAtUnixMs.

getUpdatedAtUnixMs

public long getUpdatedAtUnixMs()

int64 updated_at_unix_ms = 11;

Specified by:

getUpdatedAtUnixMs in interface RoiAnnotationOrBuilder

Returns:

The updatedAtUnixMs.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RoiAnnotation parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RoiAnnotation parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static RoiAnnotation parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static RoiAnnotation parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static RoiAnnotation parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static RoiAnnotation parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static RoiAnnotation parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public RoiAnnotation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RoiAnnotation.Builder newBuilder()

newBuilder

public static RoiAnnotation.Builder newBuilder(RoiAnnotation prototype)

toBuilder

public RoiAnnotation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RoiAnnotation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RoiAnnotation getDefaultInstance()

parser

public static com.google.protobuf.Parser<RoiAnnotation> parser()

getParserForType

public com.google.protobuf.Parser<RoiAnnotation> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RoiAnnotation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder