Package org.eclipse.dawnsci.plotting.api.trace

Interface ICoordinateSystemTrace

All Superinterfaces:
org.eclipse.january.INameable, ITrace
All Known Subinterfaces:
IImageStackTrace, IImageTrace
All Known Implementing Classes:
ImageStackTrace, ImageTrace
public interface ICoordinateSystemTrace extends ITrace

  • Method Details

    • getRegionInAxisCoordinates

      IROI getRegionInAxisCoordinates(IROI roi) throws Exception
      If the axis data set has been set, this method will return a selection region in the coordinates of the axes labels rather than the indices. If no axes are set, then the original roi is returned.
      Returns:
      ROI in label coordinates. This roi is not that useful after it is created. The data processing needs rois with indices.
      Throws:
      Exception - if the roi could not be transformed or the roi type is unknown.

    • getPointInAxisCoordinates

      double[] getPointInAxisCoordinates(double[] point) throws Exception
      If the axis data set has been set, this method will return a point in the coordinates of the axes labels rather than the indices. If no axes are set, then the original point is returned. NOTE the double[] passed in is not the pixel coordinates point from events like a mouse click (int[]). It is the data point (indices of real data the case of the image). The return value is the data point looked up in the image custom axes. If no custom axes are set (via the setAxes(..) method) then you will simply get the same double passed back.
      Parameters:
      point - in index of dataset coordinates (same as ROIs on images use).
      Returns:
      point in label coordinates.
      Throws:
      Exception - if the point could not be transformed or the point type is unknown.
      See Also:
      • invalid reference 
        ICoordinateSystem

    • getPointInImageCoordinates

      double[] getPointInImageCoordinates(double[] axisLocation) throws Exception
      For regions over images: if the axis data set has been set, this method will return a point in the coordinates of the image indices rather than the axes. If no axes are set, then the original point is returned. If the plot is 1D then the original values are returned.
      Parameters:
      point - in label coordinates
      Returns:
      point in index of dataset coordinates (same as ROIs on images use).
      Throws:
      Exception - if the point could not be transformed or the point type is unknown.
      See Also:
      • invalid reference 
        ICoordinateSystem

    • getAxes

      List<org.eclipse.january.dataset.IDataset> getAxes()
      The axes used for the trace.
      Returns: