Package biopb.image

Interface PixelsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    BinData
    getBindata()
    Pixel values
    BinDataOrBuilder
    getBindataOrBuilder()
    Pixel values
    String
    getDimensionOrder()
    A string describing the dimension order of the pixel data, e.g.
    com.google.protobuf.ByteString
    getDimensionOrderBytes()
    A string describing the dimension order of the pixel data, e.g.
    String
    getDtype()
    A string describing the data type using numpy's convention.
    com.google.protobuf.ByteString
    getDtypeBytes()
    A string describing the data type using numpy's convention.
    int
    getOffsetC()
    optional uint32 offset_c = 26;
    int
    getOffsetT()
    optional uint32 offset_t = 25;
    int
    getOffsetX()
    for large image dataset, it is necessary to send a stream of image patches instead of one monolithic data structure of the whole dataset.
    int
    getOffsetY()
    optional uint32 offset_y = 23;
    int
    getOffsetZ()
    optional uint32 offset_z = 24;
    String
    getPhysicalSizeUnit()
    physical size unit, default "µm"
    com.google.protobuf.ByteString
    getPhysicalSizeUnitBytes()
    physical size unit, default "µm"
    float
    getPhysicalSizeX()
    Physical size of a pixel.
    float
    getPhysicalSizeY()
    optional float physical_size_y = 15;
    float
    getPhysicalSizeZ()
    optional float physical_size_z = 16;
    int
    getSizeC()
    uint32 size_c = 12;
    int
    getSizeT()
    uint32 size_t = 13;
    int
    getSizeX()
    Dimensional size of pixel data array [units:none]
    int
    getSizeY()
    uint32 size_y = 10;
    int
    getSizeZ()
    uint32 size_z = 11;
    float
    getTimeIncrement()
    time_increment is used for time series that have a global timing specification instead of per-timepoint timing info.
    String
    getTimeIncrementUnit()
    time unit, default "s"
    com.google.protobuf.ByteString
    getTimeIncrementUnitBytes()
    time unit, default "s"
    boolean
    hasBindata()
    Pixel values
    boolean
    hasOffsetC()
    optional uint32 offset_c = 26;
    boolean
    hasOffsetT()
    optional uint32 offset_t = 25;
    boolean
    hasOffsetX()
    for large image dataset, it is necessary to send a stream of image patches instead of one monolithic data structure of the whole dataset.
    boolean
    hasOffsetY()
    optional uint32 offset_y = 23;
    boolean
    hasOffsetZ()
    optional uint32 offset_z = 24;
    boolean
    hasPhysicalSizeX()
    Physical size of a pixel.
    boolean
    hasPhysicalSizeY()
    optional float physical_size_y = 15;
    boolean
    hasPhysicalSizeZ()
    optional float physical_size_z = 16;
    boolean
    hasTimeIncrement()
    time_increment is used for time series that have a global timing specification instead of per-timepoint timing info.

    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

    • hasBindata

      boolean hasBindata()
       Pixel values
      .biopb.image.BinData bindata = 3;
      Returns:
      Whether the bindata field is set.

    • getBindata

      BinData getBindata()
       Pixel values
      .biopb.image.BinData bindata = 3;
      Returns:
      The bindata.

    • getBindataOrBuilder

      BinDataOrBuilder getBindataOrBuilder()
       Pixel values
      .biopb.image.BinData bindata = 3;

    • getDimensionOrder

      String getDimensionOrder()
       A string describing the dimension order of the pixel data, e.g. "XYZCT"
 The string must be a permutaion of these 5 letters even if some of the
 dimension doesn't exist in the data.
      string dimension_order = 4;
      Returns:
      The dimensionOrder.

    • getDimensionOrderBytes

      com.google.protobuf.ByteString getDimensionOrderBytes()
       A string describing the dimension order of the pixel data, e.g. "XYZCT"
 The string must be a permutaion of these 5 letters even if some of the
 dimension doesn't exist in the data.
      string dimension_order = 4;
      Returns:
      The bytes for dimensionOrder.

    • getDtype

      String getDtype()
       A string describing the data type using numpy's convention. E.g., 'i8'
 represent int64. Endianness indicator, e.g. '=i8', is allowed but will be
 ignored. Instead the endianness will be determined by the field within
 the Bindata structure.
      string dtype = 5;
      Returns:
      The dtype.

    • getDtypeBytes

      com.google.protobuf.ByteString getDtypeBytes()
       A string describing the data type using numpy's convention. E.g., 'i8'
 represent int64. Endianness indicator, e.g. '=i8', is allowed but will be
 ignored. Instead the endianness will be determined by the field within
 the Bindata structure.
      string dtype = 5;
      Returns:
      The bytes for dtype.

    • getSizeX

      int getSizeX()
       Dimensional size of pixel data array [units:none]
      uint32 size_x = 9;
      Returns:
      The sizeX.

    • getSizeY

      int getSizeY()
      uint32 size_y = 10;
      Returns:
      The sizeY.

    • getSizeZ

      int getSizeZ()
      uint32 size_z = 11;
      Returns:
      The sizeZ.

    • getSizeC

      int getSizeC()
      uint32 size_c = 12;
      Returns:
      The sizeC.

    • getSizeT

      int getSizeT()
      uint32 size_t = 13;
      Returns:
      The sizeT.

    • hasPhysicalSizeX

      boolean hasPhysicalSizeX()
       Physical size of a pixel.
      optional float physical_size_x = 14;
      Returns:
      Whether the physicalSizeX field is set.

    • getPhysicalSizeX

      float getPhysicalSizeX()
       Physical size of a pixel.
      optional float physical_size_x = 14;
      Returns:
      The physicalSizeX.

    • hasPhysicalSizeY

      boolean hasPhysicalSizeY()
      optional float physical_size_y = 15;
      Returns:
      Whether the physicalSizeY field is set.

    • getPhysicalSizeY

      float getPhysicalSizeY()
      optional float physical_size_y = 15;
      Returns:
      The physicalSizeY.

    • hasPhysicalSizeZ

      boolean hasPhysicalSizeZ()
      optional float physical_size_z = 16;
      Returns:
      Whether the physicalSizeZ field is set.

    • getPhysicalSizeZ

      float getPhysicalSizeZ()
      optional float physical_size_z = 16;
      Returns:
      The physicalSizeZ.

    • getPhysicalSizeUnit

      String getPhysicalSizeUnit()
       physical size unit, default "µm"
      string physical_size_unit = 17;
      Returns:
      The physicalSizeUnit.

    • getPhysicalSizeUnitBytes

      com.google.protobuf.ByteString getPhysicalSizeUnitBytes()
       physical size unit, default "µm"
      string physical_size_unit = 17;
      Returns:
      The bytes for physicalSizeUnit.

    • hasTimeIncrement

      boolean hasTimeIncrement()
       time_increment is used for time series that have a global timing
 specification instead of per-timepoint timing info. For example in a
 video stream. Units are set by TimeIncrementUnit.
      optional float time_increment = 18;
      Returns:
      Whether the timeIncrement field is set.

    • getTimeIncrement

      float getTimeIncrement()
       time_increment is used for time series that have a global timing
 specification instead of per-timepoint timing info. For example in a
 video stream. Units are set by TimeIncrementUnit.
      optional float time_increment = 18;
      Returns:
      The timeIncrement.

    • getTimeIncrementUnit

      String getTimeIncrementUnit()
       time unit, default "s"
      string time_increment_unit = 21;
      Returns:
      The timeIncrementUnit.

    • getTimeIncrementUnitBytes

      com.google.protobuf.ByteString getTimeIncrementUnitBytes()
       time unit, default "s"
      string time_increment_unit = 21;
      Returns:
      The bytes for timeIncrementUnit.

    • hasOffsetX

      boolean hasOffsetX()
       for large image dataset, it is necessary to send a stream of image
 patches instead of one monolithic data structure of the whole dataset.
 The offset values allows one to specify the relative locations of each
 patch. These include spatial (x,y,z), channel (c), and time (t) offsets.
      optional uint32 offset_x = 22;
      Returns:
      Whether the offsetX field is set.

    • getOffsetX

      int getOffsetX()
       for large image dataset, it is necessary to send a stream of image
 patches instead of one monolithic data structure of the whole dataset.
 The offset values allows one to specify the relative locations of each
 patch. These include spatial (x,y,z), channel (c), and time (t) offsets.
      optional uint32 offset_x = 22;
      Returns:
      The offsetX.

    • hasOffsetY

      boolean hasOffsetY()
      optional uint32 offset_y = 23;
      Returns:
      Whether the offsetY field is set.

    • getOffsetY

      int getOffsetY()
      optional uint32 offset_y = 23;
      Returns:
      The offsetY.

    • hasOffsetZ

      boolean hasOffsetZ()
      optional uint32 offset_z = 24;
      Returns:
      Whether the offsetZ field is set.

    • getOffsetZ

      int getOffsetZ()
      optional uint32 offset_z = 24;
      Returns:
      The offsetZ.

    • hasOffsetT

      boolean hasOffsetT()
      optional uint32 offset_t = 25;
      Returns:
      Whether the offsetT field is set.

    • getOffsetT

      int getOffsetT()
      optional uint32 offset_t = 25;
      Returns:
      The offsetT.

    • hasOffsetC

      boolean hasOffsetC()
      optional uint32 offset_c = 26;
      Returns:
      Whether the offsetC field is set.

    • getOffsetC

      int getOffsetC()
      optional uint32 offset_c = 26;
      Returns:
      The offsetC.