Package biopb.tensor

Interface PyramidLevelOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getNative()
    True if this level is served from a precomputed on-disk pyramid (e.g.
    String
    getReductionMethod()
    Method to request this level: "area" | "nearest" | "precompute".
    com.google.protobuf.ByteString
    getReductionMethodBytes()
    Method to request this level: "area" | "nearest" | "precompute".
    long
    getScaleHint(int index)
    Per-dimension integer downsampling factors vs.
    int
    getScaleHintCount()
    Per-dimension integer downsampling factors vs.
    List<Long>
    getScaleHintList()
    Per-dimension integer downsampling factors vs.
    long
    getShape(int index)
    Logical (downsampled) shape of this level -- what a read of this level returns, so the client can size the level without a probe read.
    int
    getShapeCount()
    Logical (downsampled) shape of this level -- what a read of this level returns, so the client can size the level without a probe read.
    List<Long>
    getShapeList()
    Logical (downsampled) shape of this level -- what a read of this level returns, so the client can size the level without a probe 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

    • getScaleHintList

      List<Long> getScaleHintList()
       Per-dimension integer downsampling factors vs. full resolution.
 Level 0 is [1, 1, ...]; matches TensorDescriptor.scale_hint semantics.
      repeated int64 scale_hint = 1;
      Returns:
      A list containing the scaleHint.

    • getScaleHintCount

      int getScaleHintCount()
       Per-dimension integer downsampling factors vs. full resolution.
 Level 0 is [1, 1, ...]; matches TensorDescriptor.scale_hint semantics.
      repeated int64 scale_hint = 1;
      Returns:
      The count of scaleHint.

    • getScaleHint

      long getScaleHint(int index)
       Per-dimension integer downsampling factors vs. full resolution.
 Level 0 is [1, 1, ...]; matches TensorDescriptor.scale_hint semantics.
      repeated int64 scale_hint = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scaleHint at the given index.

    • getReductionMethod

      String getReductionMethod()
       Method to request this level: "area" | "nearest" | "precompute".
 "precompute" means the server serves a native on-disk level (see `native`).
      string reduction_method = 2;
      Returns:
      The reductionMethod.

    • getReductionMethodBytes

      com.google.protobuf.ByteString getReductionMethodBytes()
       Method to request this level: "area" | "nearest" | "precompute".
 "precompute" means the server serves a native on-disk level (see `native`).
      string reduction_method = 2;
      Returns:
      The bytes for reductionMethod.

    • getShapeList

      List<Long> getShapeList()
       Logical (downsampled) shape of this level -- what a read of this level
 returns, so the client can size the level without a probe read.
      repeated int64 shape = 3;
      Returns:
      A list containing the shape.

    • getShapeCount

      int getShapeCount()
       Logical (downsampled) shape of this level -- what a read of this level
 returns, so the client can size the level without a probe read.
      repeated int64 shape = 3;
      Returns:
      The count of shape.

    • getShape

      long getShape(int index)
       Logical (downsampled) shape of this level -- what a read of this level
 returns, so the client can size the level without a probe read.
      repeated int64 shape = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The shape at the given index.

    • getNative

      boolean getNative()
       True if this level is served from a precomputed on-disk pyramid (e.g. an
 OME-Zarr multiscales dataset) rather than downsampled on the fly.
      bool native = 4;
      Returns:
      The native.