Package biopb.tensor

Interface TensorDescriptorOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getArrayId()
    Globally-unique tensor identifier and primary key (see the tensor identity policy above).
    com.google.protobuf.ByteString
    getArrayIdBytes()
    Globally-unique tensor identifier and primary key (see the tensor identity policy above).
    long
    getChunkShape(int index)
    Nominal chunk size per dimension (actual may vary for edge chunks)
    int
    getChunkShapeCount()
    Nominal chunk size per dimension (actual may vary for edge chunks)
    List<Long>
    getChunkShapeList()
    Nominal chunk size per dimension (actual may vary for edge chunks)
    String
    getDimLabels(int index)
    Maps dimension index to semantic label (e.g., ["z", "y", "x"])
    com.google.protobuf.ByteString
    getDimLabelsBytes(int index)
    Maps dimension index to semantic label (e.g., ["z", "y", "x"])
    int
    getDimLabelsCount()
    Maps dimension index to semantic label (e.g., ["z", "y", "x"])
    List<String>
    getDimLabelsList()
    Maps dimension index to semantic label (e.g., ["z", "y", "x"])
    String
    getDtype()
    Element dtype (numpy-style, e.g., "uint8", "float32", "float64")
    com.google.protobuf.ByteString
    getDtypeBytes()
    Element dtype (numpy-style, e.g., "uint8", "float32", "float64")
    String
    getMetadataJson()
    Opaque JSON metadata compatible with OME-NGFF (.zattrs schema).
    com.google.protobuf.ByteString
    getMetadataJsonBytes()
    Opaque JSON metadata compatible with OME-NGFF (.zattrs schema).
    double
    getPhysicalScale(int index)
    Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape (same length and order).
    int
    getPhysicalScaleCount()
    Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape (same length and order).
    List<Double>
    getPhysicalScaleList()
    Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape (same length and order).
    String
    getPhysicalUnit(int index)
    Per-dimension unit string for physical_scale (e.g.
    com.google.protobuf.ByteString
    getPhysicalUnitBytes(int index)
    Per-dimension unit string for physical_scale (e.g.
    int
    getPhysicalUnitCount()
    Per-dimension unit string for physical_scale (e.g.
    List<String>
    getPhysicalUnitList()
    Per-dimension unit string for physical_scale (e.g.
    PyramidLevel
    getPyramid(int index)
    Server-advertised resolution pyramid: the ordered levels the server recommends reading this tensor at, coarsest decision made server-side so native (precomputed) pyramids are honored and the precache worker and client request the same scales.
    int
    getPyramidCount()
    Server-advertised resolution pyramid: the ordered levels the server recommends reading this tensor at, coarsest decision made server-side so native (precomputed) pyramids are honored and the precache worker and client request the same scales.
    List<PyramidLevel>
    getPyramidList()
    Server-advertised resolution pyramid: the ordered levels the server recommends reading this tensor at, coarsest decision made server-side so native (precomputed) pyramids are honored and the precache worker and client request the same scales.
    PyramidLevelOrBuilder
    getPyramidOrBuilder(int index)
    Server-advertised resolution pyramid: the ordered levels the server recommends reading this tensor at, coarsest decision made server-side so native (precomputed) pyramids are honored and the precache worker and client request the same scales.
    List<? extends PyramidLevelOrBuilder>
    getPyramidOrBuilderList()
    Server-advertised resolution pyramid: the ordered levels the server recommends reading this tensor at, coarsest decision made server-side so native (precomputed) pyramids are honored and the precache worker and client request the same scales.
    String
    getReductionMethod()
    Dynamic reduction/downsampling method for scaled reads: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
    com.google.protobuf.ByteString
    getReductionMethodBytes()
    Dynamic reduction/downsampling method for scaled reads: "nearest", "area", or "precompute" (serve a native on-disk pyramid level).
    long
    getScaleHint(int index)
    Per-dimension integer downsampling factors for virtual/scaled reads.
    int
    getScaleHintCount()
    Per-dimension integer downsampling factors for virtual/scaled reads.
    List<Long>
    getScaleHintList()
    Per-dimension integer downsampling factors for virtual/scaled reads.
    long
    getShape(int index)
    Full array shape (per dimension)
    int
    getShapeCount()
    Full array shape (per dimension)
    List<Long>
    getShapeList()
    Full array shape (per dimension)
    SliceHint
    getSliceHint()
    Optional slice hint - if provided, GetFlightInfo returns only chunks covering this range.
    SliceHintOrBuilder
    getSliceHintOrBuilder()
    Optional slice hint - if provided, GetFlightInfo returns only chunks covering this range.
    boolean
    hasSliceHint()
    Optional slice hint - if provided, GetFlightInfo returns only chunks covering this range.

    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()
       Globally-unique tensor identifier and primary key (see the tensor identity
 policy above). Constructed as source_id (single-tensor) or source_id/field
 (multi-tensor). Same value as TensorReadOption.tensor_id.
      string array_id = 1;
      Returns:
      The arrayId.

    • getArrayIdBytes

      com.google.protobuf.ByteString getArrayIdBytes()
       Globally-unique tensor identifier and primary key (see the tensor identity
 policy above). Constructed as source_id (single-tensor) or source_id/field
 (multi-tensor). Same value as TensorReadOption.tensor_id.
      string array_id = 1;
      Returns:
      The bytes for arrayId.

    • getDimLabelsList

      List<String> getDimLabelsList()
       Maps dimension index to semantic label (e.g., ["z", "y", "x"])
      repeated string dim_labels = 2;
      Returns:
      A list containing the dimLabels.

    • getDimLabelsCount

      int getDimLabelsCount()
       Maps dimension index to semantic label (e.g., ["z", "y", "x"])
      repeated string dim_labels = 2;
      Returns:
      The count of dimLabels.

    • getDimLabels

      String getDimLabels(int index)
       Maps dimension index to semantic label (e.g., ["z", "y", "x"])
      repeated string dim_labels = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The dimLabels at the given index.

    • getDimLabelsBytes

      com.google.protobuf.ByteString getDimLabelsBytes(int index)
       Maps dimension index to semantic label (e.g., ["z", "y", "x"])
      repeated string dim_labels = 2;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the dimLabels at the given index.

    • getShapeList

      List<Long> getShapeList()
       Full array shape (per dimension)
      repeated int64 shape = 3;
      Returns:
      A list containing the shape.

    • getShapeCount

      int getShapeCount()
       Full array shape (per dimension)
      repeated int64 shape = 3;
      Returns:
      The count of shape.

    • getShape

      long getShape(int index)
       Full array shape (per dimension)
      repeated int64 shape = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The shape at the given index.

    • getChunkShapeList

      List<Long> getChunkShapeList()
       Nominal chunk size per dimension (actual may vary for edge chunks)
      repeated int64 chunk_shape = 4;
      Returns:
      A list containing the chunkShape.

    • getChunkShapeCount

      int getChunkShapeCount()
       Nominal chunk size per dimension (actual may vary for edge chunks)
      repeated int64 chunk_shape = 4;
      Returns:
      The count of chunkShape.

    • getChunkShape

      long getChunkShape(int index)
       Nominal chunk size per dimension (actual may vary for edge chunks)
      repeated int64 chunk_shape = 4;
      Parameters:
      index - The index of the element to return.
      Returns:
      The chunkShape at the given index.

    • getDtype

      String getDtype()
       Element dtype (numpy-style, e.g., "uint8", "float32", "float64")
      string dtype = 5;
      Returns:
      The dtype.

    • getDtypeBytes

      com.google.protobuf.ByteString getDtypeBytes()
       Element dtype (numpy-style, e.g., "uint8", "float32", "float64")
      string dtype = 5;
      Returns:
      The bytes for dtype.

    • hasSliceHint

      boolean hasSliceHint()
       Optional slice hint - if provided, GetFlightInfo returns only chunks
 covering this range. Leave unset/null to return all chunks.
      .biopb.tensor.SliceHint slice_hint = 6;
      Returns:
      Whether the sliceHint field is set.

    • getSliceHint

      SliceHint getSliceHint()
       Optional slice hint - if provided, GetFlightInfo returns only chunks
 covering this range. Leave unset/null to return all chunks.
      .biopb.tensor.SliceHint slice_hint = 6;
      Returns:
      The sliceHint.

    • getSliceHintOrBuilder

      SliceHintOrBuilder getSliceHintOrBuilder()
       Optional slice hint - if provided, GetFlightInfo returns only chunks
 covering this range. Leave unset/null to return all chunks.
      .biopb.tensor.SliceHint slice_hint = 6;

    • getScaleHintList

      List<Long> getScaleHintList()
       Per-dimension integer downsampling factors for virtual/scaled reads.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 These do not change tensor identity, only how a specific read request is planned.
      repeated int64 scale_hint = 7;
      Returns:
      A list containing the scaleHint.

    • getScaleHintCount

      int getScaleHintCount()
       Per-dimension integer downsampling factors for virtual/scaled reads.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 These do not change tensor identity, only how a specific read request is planned.
      repeated int64 scale_hint = 7;
      Returns:
      The count of scaleHint.

    • getScaleHint

      long getScaleHint(int index)
       Per-dimension integer downsampling factors for virtual/scaled reads.
 Example: [1, 8, 8] means full resolution on first axis, 8x reduced on remaining.
 These do not change tensor identity, only how a specific read request is planned.
      repeated int64 scale_hint = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scaleHint at the given index.

    • getReductionMethod

      String getReductionMethod()
       Dynamic reduction/downsampling method for scaled reads: "nearest", "area",
 or "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
 Advisory for caching: the server may serve an existing cached chunk
 computed under a different method at the same bounds/scale.
      string reduction_method = 8;
      Returns:
      The reductionMethod.

    • getReductionMethodBytes

      com.google.protobuf.ByteString getReductionMethodBytes()
       Dynamic reduction/downsampling method for scaled reads: "nearest", "area",
 or "precompute" (serve a native on-disk pyramid level).
 Compatibility aliases accepted: "stride" -> "nearest", "mean" -> "area",
 "precomputed" -> "precompute", "linear" (deprecated) -> "area".
 Advisory for caching: the server may serve an existing cached chunk
 computed under a different method at the same bounds/scale.
      string reduction_method = 8;
      Returns:
      The bytes for reductionMethod.

    • getMetadataJson

      String getMetadataJson()
       Opaque JSON metadata compatible with OME-NGFF (.zattrs schema).
 Contains: multiscales, axes, coordinateTransformations, channels, etc.
 For precomputed pyramids: multiscales[].datasets[].path and scale info.
 Empty string if no metadata available.
      string metadata_json = 9;
      Returns:
      The metadataJson.

    • getMetadataJsonBytes

      com.google.protobuf.ByteString getMetadataJsonBytes()
       Opaque JSON metadata compatible with OME-NGFF (.zattrs schema).
 Contains: multiscales, axes, coordinateTransformations, channels, etc.
 For precomputed pyramids: multiscales[].datasets[].path and scale info.
 Empty string if no metadata available.
      string metadata_json = 9;
      Returns:
      The bytes for metadataJson.

    • getPyramidList

      List<PyramidLevel> getPyramidList()
       Server-advertised resolution pyramid: the ordered levels the server
 recommends reading this tensor at, coarsest decision made server-side so
 native (precomputed) pyramids are honored and the precache worker and
 client request the same scales. Level 0 is full resolution
 (scale_hint all 1s). A client reads each level via the normal scale_hint
 read path. Populated only by GetFlightInfo (left empty in ListFlights,
 like metadata_json); empty also means "old server / decide client-side".
      repeated .biopb.tensor.PyramidLevel pyramid = 10;

    • getPyramid

      PyramidLevel getPyramid(int index)
       Server-advertised resolution pyramid: the ordered levels the server
 recommends reading this tensor at, coarsest decision made server-side so
 native (precomputed) pyramids are honored and the precache worker and
 client request the same scales. Level 0 is full resolution
 (scale_hint all 1s). A client reads each level via the normal scale_hint
 read path. Populated only by GetFlightInfo (left empty in ListFlights,
 like metadata_json); empty also means "old server / decide client-side".
      repeated .biopb.tensor.PyramidLevel pyramid = 10;

    • getPyramidCount

      int getPyramidCount()
       Server-advertised resolution pyramid: the ordered levels the server
 recommends reading this tensor at, coarsest decision made server-side so
 native (precomputed) pyramids are honored and the precache worker and
 client request the same scales. Level 0 is full resolution
 (scale_hint all 1s). A client reads each level via the normal scale_hint
 read path. Populated only by GetFlightInfo (left empty in ListFlights,
 like metadata_json); empty also means "old server / decide client-side".
      repeated .biopb.tensor.PyramidLevel pyramid = 10;

    • getPyramidOrBuilderList

      List<? extends PyramidLevelOrBuilder> getPyramidOrBuilderList()
       Server-advertised resolution pyramid: the ordered levels the server
 recommends reading this tensor at, coarsest decision made server-side so
 native (precomputed) pyramids are honored and the precache worker and
 client request the same scales. Level 0 is full resolution
 (scale_hint all 1s). A client reads each level via the normal scale_hint
 read path. Populated only by GetFlightInfo (left empty in ListFlights,
 like metadata_json); empty also means "old server / decide client-side".
      repeated .biopb.tensor.PyramidLevel pyramid = 10;

    • getPyramidOrBuilder

      PyramidLevelOrBuilder getPyramidOrBuilder(int index)
       Server-advertised resolution pyramid: the ordered levels the server
 recommends reading this tensor at, coarsest decision made server-side so
 native (precomputed) pyramids are honored and the precache worker and
 client request the same scales. Level 0 is full resolution
 (scale_hint all 1s). A client reads each level via the normal scale_hint
 read path. Populated only by GetFlightInfo (left empty in ListFlights,
 like metadata_json); empty also means "old server / decide client-side".
      repeated .biopb.tensor.PyramidLevel pyramid = 10;

    • getPhysicalScaleList

      List<Double> getPhysicalScaleList()
       Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape
 (same length and order). Element i is the physical extent of one sample
 along dimension i, in the unit given by physical_unit[i]. 0.0 means
 "unknown" for that dimension. This is the ~200-byte summary consumers need
 for display scale, so the common case avoids fetching the full OME tree.
 Populated by GetFlightInfo (left empty in ListFlights, like pyramid /
 metadata_json); empty also means "old server / no physical scale -> the
 full OME (metadata_json) remains the authoritative source".
      repeated double physical_scale = 11;
      Returns:
      A list containing the physicalScale.

    • getPhysicalScaleCount

      int getPhysicalScaleCount()
       Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape
 (same length and order). Element i is the physical extent of one sample
 along dimension i, in the unit given by physical_unit[i]. 0.0 means
 "unknown" for that dimension. This is the ~200-byte summary consumers need
 for display scale, so the common case avoids fetching the full OME tree.
 Populated by GetFlightInfo (left empty in ListFlights, like pyramid /
 metadata_json); empty also means "old server / no physical scale -> the
 full OME (metadata_json) remains the authoritative source".
      repeated double physical_scale = 11;
      Returns:
      The count of physicalScale.

    • getPhysicalScale

      double getPhysicalScale(int index)
       Per-dimension physical pixel size, aligned 1:1 with dim_labels/shape
 (same length and order). Element i is the physical extent of one sample
 along dimension i, in the unit given by physical_unit[i]. 0.0 means
 "unknown" for that dimension. This is the ~200-byte summary consumers need
 for display scale, so the common case avoids fetching the full OME tree.
 Populated by GetFlightInfo (left empty in ListFlights, like pyramid /
 metadata_json); empty also means "old server / no physical scale -> the
 full OME (metadata_json) remains the authoritative source".
      repeated double physical_scale = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The physicalScale at the given index.

    • getPhysicalUnitList

      List<String> getPhysicalUnitList()
       Per-dimension unit string for physical_scale (e.g. "micrometer", "µm"),
 aligned 1:1 with physical_scale. "" means unknown.
      repeated string physical_unit = 12;
      Returns:
      A list containing the physicalUnit.

    • getPhysicalUnitCount

      int getPhysicalUnitCount()
       Per-dimension unit string for physical_scale (e.g. "micrometer", "µm"),
 aligned 1:1 with physical_scale. "" means unknown.
      repeated string physical_unit = 12;
      Returns:
      The count of physicalUnit.

    • getPhysicalUnit

      String getPhysicalUnit(int index)
       Per-dimension unit string for physical_scale (e.g. "micrometer", "µm"),
 aligned 1:1 with physical_scale. "" means unknown.
      repeated string physical_unit = 12;
      Parameters:
      index - The index of the element to return.
      Returns:
      The physicalUnit at the given index.

    • getPhysicalUnitBytes

      com.google.protobuf.ByteString getPhysicalUnitBytes(int index)
       Per-dimension unit string for physical_scale (e.g. "micrometer", "µm"),
 aligned 1:1 with physical_scale. "" means unknown.
      repeated string physical_unit = 12;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the physicalUnit at the given index.