Personal tools
  • We're Hiring!

You are here: Home → Documentation → Previous versions → OME Server → Developer → Image Server → Method Reference → Rows/Scanlines

Rows/Scanlines

Methods that operate on one or more rows (or scanlines) of Pixels

  • SetRows - Write one or more rows of Pixels.
    • Required Parameters:
      • PixelsID - The Pixels ID of the Pixels that will be written.
      • theY - The Y coordinate where to start writing pixels.
      • theZ - The Z coordinate where to start writing pixels.
      • theC - The C coordinate where to start writing pixels.
      • theT - The T coordinate where to start writing pixels.
      • Pixels - The pixels in binary form are sent as a multi-part form in a POST request. The form field must be called "Pixels" and it must be the last part of the form.
        When using the command line, the Pixels parameter doesn't have to be specified. The raw binary pixels are read from stdin.
        The number of pixels sent must exactly match the number of pixels in the specified number of rows.
        The pixels must be in XY order if nRows > 1.
    • Optional Parameters:
      • nRows - Number of rows to write. By default, nRows=1
      • BigEndian - boolean. Set to 0 if the pixels being sent are in little endian byte order. By default, BigEndian=1 (network order)
    • Return value: Number of pixels written
  • GetRows - Get one or more rows of Pixels.
    • Required Parameters:
      • PixelsID - The Pixels ID of the Pixels that will be read.
      • theY - The Y coordinate where to start reading pixels.
      • theZ - The Z coordinate where to start reading pixels.
      • theC - The C coordinate where to start reading pixels.
      • theT - The T coordinate where to start reading pixels.
    • Optional Parameters:
      • nRows - Number of rows to read. By default, nRows=1
      • BigEndian - boolean. Set to 0 if the pixels should be sent in little endian byte order. By default, BigEndian=1 (network order)
    • Return value: The pixels in binary form in XY order with an application/octet-stream mime-type.
  • ConvertRows - Read one or more rows from an uploaded file, and write them to the specified set of Pixels.
    • Required Parameters:
      • PixelsID - The Pixels ID of the Pixels that will be written.
      • FileID - The File ID that the pixels will be read from. The pixels in the file must be in XY order if nRows > 1.
      • theY - The Y coordinate where to start writing pixels.
      • theZ - The Z coordinate where to start writing pixels.
      • theC - The C coordinate where to start writing pixels.
      • theT - The T coordinate where to start writing pixels.
    • Optional Parameters:
      • nRows - Number of rows to read. By default, nRows=1
      • Offset - Number of bytes to skip in the file before reading pixels. Useful when the file contains a header, or contains multiple non-contiguous sets of rows. By default, Offset=0.
      • BigEndian - boolean. Set to 0 if the file being converted is in little endian byte order. By default, BigEndian=1 (network order)
    • Return value: The pixels in binary form in XY order with an application/octet-stream mime-type.
Document Actions