Package com.xinapse.multisliceimage.roi

Interface LinearROI

All Known Implementing Classes:
CurvedLineROI, LineROI, OpenSplineROI
public interface LinearROI
Interface that ROIs having the property of linearity implement. Linear ROIs have a length, and can show a profile of intensities along their length.

  • Method Summary

    Modifier and Type
    Method
    Description
    Point2D[]
    getIntensityProfile(Object pix, PixelDataType dataType, int nCols, int nRows, int offset, float pixelXSize, float pixelYSize, ComplexMode complexMode)
    Returns an array of Point2D representing the pixel intensities along this LinearROI.
    double
    getLength()
    Returns the length of this ROI in mm.
    double
    getLengthPix(float pixelXSize, float pixelYSize)
    Returns the length of this ROI in image pixels.

  • Method Details

    • getLength

      double getLength()
      Returns the length of this ROI in mm.
      Returns:
      the length of this ROI in mm.

    • getIntensityProfile

      Point2D[] getIntensityProfile(Object pix, PixelDataType dataType, int nCols, int nRows, int offset, float pixelXSize, float pixelYSize, ComplexMode complexMode)
      Returns an array of Point2D representing the pixel intensities along this LinearROI. The x-value of a point is a position along the LinearROI, and the y-value is the intensity. The first and last points will be at the ends of the LinearROI, but the location of the points in between is not prescribed by this interface.
      Parameters:
      pix - the array of pixel intensities for in which this LinearROI is positioned.
      dataType - the PixelDataType of the array of pixel intensities.
      nCols - the number of columns in the slice.
      nRows - the number of rows in the slice.
      offset - an offset (in pixels) into the pixel value array for the starting pixel of the slice on which this ROI is defined.
      pixelXSize - the size of image pixels in the horizontal direction.
      pixelYSize - the size of image pixels in the vertical direction.
      complexMode - the calculation mode for Complex images. The intensity profile returned will correspond to the mode: the real part, imaginary part, magnitude or phase.
      Returns:
      an array of Point2D representing the pixel intensities along this LinearROI.

    • getLengthPix

      double getLengthPix(float pixelXSize, float pixelYSize)
      Returns the length of this ROI in image pixels.
      Parameters:
      pixelXSize - the size of image pixels in the horizontal direction.
      pixelYSize - the size of image pixels in the vertical direction.
      Returns:
      the length of this ROI in image pixels.