ROIs

Methods that operate on ROIs - Regions of Interest

• SetROI [C] [MATLAB] - Write an ROI to the specified set of Pixels.
  • Required Parameters:
    • PixelsID - The Pixels ID of the Pixels that will be written.
    • ROI - ROI=x0,y0,z0,c0,t0,x1,y1,z1,c1,t1. The starting (x0, y0, etc) and ending (x1, y1, etc) coordinates of a 5-dimensional box describing the ROI.
    • 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 ROI.
      The pixels must be in XYZCT order.
  • Optional Parameters:
    • 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

• GetROI [C] [MATLAB] - Get an ROI from the specified set of Pixels.
  • Required Parameters:
    • PixelsID - The Pixels ID of the Pixels that will be read.
    • ROI - ROI=x0,y0,z0,c0,t0,x1,y1,z1,c1,t1. The starting (x0, y0, etc) and ending (x1, y1, etc) coordinates of a 5-dimensional box describing the ROI.
  • Optional Parameters:
    • 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 XYZCT order with an application/octet-stream mime-type.