Package biopb.tensor

Interface TensorReadOptionOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArrayId()
    Which tensor to read: its globally-unique array_id ("source_id" or "source_id/field", per the identity policy at the top of this file).
    com.google.protobuf.ByteString
    getArrayIdBytes()
    Which tensor to read: its globally-unique array_id ("source_id" or "source_id/field", per the identity policy at the top of this file).
    com.google.protobuf.FieldMask
    getFields()
    Which optional parts of the response to fill.
    com.google.protobuf.FieldMaskOrBuilder
    getFieldsOrBuilder()
    Which optional parts of the response to fill.
    String
    getReductionMethod()
    Dynamic reduction/downsampling method: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
    com.google.protobuf.ByteString
    getReductionMethodBytes()
    Dynamic reduction/downsampling method: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
    long
    getScaleHint(int index)
    Per-dimension integer downsampling factors.
    int
    getScaleHintCount()
    Per-dimension integer downsampling factors.
    List<Long>
    getScaleHintList()
    Per-dimension integer downsampling factors.
    SliceHint
    getSliceHint()
    Optional sub-region to read
    SliceHintOrBuilder
    getSliceHintOrBuilder()
    Optional sub-region to read
    boolean
    hasFields()
    Which optional parts of the response to fill.
    boolean
    hasSliceHint()
    Optional sub-region to read

    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

    • getArrayId

      String getArrayId()
       Which tensor to read: its globally-unique array_id ("source_id" or
 "source_id/field", per the identity policy at the top of this file). A bare
 source_id selects the source's default (first) tensor (#44).
      string array_id = 1;
      Returns:
      The arrayId.

    • getArrayIdBytes

      com.google.protobuf.ByteString getArrayIdBytes()
       Which tensor to read: its globally-unique array_id ("source_id" or
 "source_id/field", per the identity policy at the top of this file). A bare
 source_id selects the source's default (first) tensor (#44).
      string array_id = 1;
      Returns:
      The bytes for arrayId.

    • hasSliceHint

      boolean hasSliceHint()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;
      Returns:
      Whether the sliceHint field is set.

    • getSliceHint

      SliceHint getSliceHint()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;
      Returns:
      The sliceHint.

    • getSliceHintOrBuilder

      SliceHintOrBuilder getSliceHintOrBuilder()
       Optional sub-region to read
      .biopb.tensor.SliceHint slice_hint = 2;

    • getScaleHintList

      List<Long> getScaleHintList()
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Returns:
      A list containing the scaleHint.

    • getScaleHintCount

      int getScaleHintCount()
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Returns:
      The count of scaleHint.

    • getScaleHint

      long getScaleHint(int index)
       Per-dimension integer downsampling factors.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
      repeated int64 scale_hint = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scaleHint at the given index.

    • getReductionMethod

      String getReductionMethod()
       Dynamic reduction/downsampling method: "nearest", "area", or
 "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
      string reduction_method = 4;
      Returns:
      The reductionMethod.

    • getReductionMethodBytes

      com.google.protobuf.ByteString getReductionMethodBytes()
       Dynamic reduction/downsampling method: "nearest", "area", or
 "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
      string reduction_method = 4;
      Returns:
      The bytes for reductionMethod.

    • hasFields

      boolean hasFields()
       Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
      .google.protobuf.FieldMask fields = 9;
      Returns:
      Whether the fields field is set.

    • getFields

      com.google.protobuf.FieldMask getFields()
       Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
      .google.protobuf.FieldMask fields = 9;
      Returns:
      The fields.

    • getFieldsOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getFieldsOrBuilder()
       Which optional parts of the response to fill.

 **Empty means none.** The response then carries this tensor's base
 descriptor -- array_id, dim_labels, shape, chunk_shape, dtype, and the
 ~200-byte physical_scale/physical_unit, which stay unconditional as the one
 cheap describe fact -- and an empty endpoint list.

 Paths name what they fill on the response:

   "endpoints"     - the per-request chunk read plan. O(chunks); a read asks
                     for this, a describe does not.
   "metadata_json" - the full OME tree. Megabytes on a per-plane-annotated
                     file.
   "pyramid"       - the advertised resolution pyramid. Sizing a native one
                     opens each level's store (network I/O per level on a
                     cloud store).
   "upload_status" - progress of the upload backing this tensor, if any.
                     The one cheap path: an in-memory record read.
   "is_resident"   - whether the bytes are local right now. A bounded stat
                     walk of the source (biopb/biopb#1035).

 Opt-in throughout, and that is the point of replacing the three `with_*`
 bools this supersedes: they defaulted the *most* expensive part, the read
 plan, to on, so a describe had to remember to turn it off. Nothing here is
 free, so nothing here is default.

 An unknown path is refused, not ignored: a client asking for something this
 server does not serve should learn so, rather than silently receive a
 response missing the field it planned around.
      .google.protobuf.FieldMask fields = 9;