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

Interface ITrace

All Superinterfaces:
org.eclipse.january.INameable
All Known Subinterfaces:
IArpesSliceTrace, IAxesTrace, ICoordinateSystemTrace, IDownsampledTrace, IHyper4DTrace, IHyperTrace, IImage3DTrace, IImageStackTrace, IImageTrace, IIsosurfaceTrace, ILazyBlockTrace, ILine3DTrace, ILineStackTrace, ILineTrace, IMulti2DTrace, IPaletteTrace, IPlane3DTrace, IScatter3DTrace, ISurfaceMeshTrace, ISurfaceTrace, ITableDataTrace, IVectorTrace, IVolumeRenderTrace, IVolumeTrace, IWaterfallTrace, IWindowTrace
All Known Implementing Classes:
ArpesSliceTrace, BaseHyperTrace, Hyper4DTrace, HyperTrace, Image3DTrace, ImageStackTrace, ImageTrace, LineTraceImpl, Multi2DTrace, Scatter3DTrace, StackTrace, SurfaceTrace, VectorTrace
public interface ITrace extends org.eclipse.january.INameable
A representation of a plotted data set.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Called to release system resources.
    org.eclipse.january.dataset.IDataset
    getData()
    Call this method to return a plotted data set by this trace.
    String
    getDataName()
    The name of the original data that this trace was plotted from or null
    int
    getRank()
    The rank of data plotted, 1 for XY, 2 for Image and surfaces, 3 for volumes.
    Object
    getUserObject()
    An object which may be set by API users to record information about the plot.
    void
    initialize(IAxis... axes)
    Initialize with given axes
    boolean
    is3DTrace()
     
    boolean
    isUserTrace()
    True if user trace (normally is)
    boolean
    isVisible()
    True if visible
    void
    setDataName(String name)
    The name of the original data that this trace was plotted from or null
    void
    setUserObject(Object userObject)
    An object which may be set by API users to record information about the plot.
    void
    setUserTrace(boolean isUserTrace)
    True if visible
    void
    setVisible(boolean isVisible)
    True if visible

    Methods inherited from interface org.eclipse.january.INameable

    getName, setName

  • Method Details

    • initialize

      void initialize(IAxis... axes)
      Initialize with given axes
      Parameters:
      axes -

    • getDataName

      String getDataName()
      The name of the original data that this trace was plotted from or null
      Returns:

    • setDataName

      void setDataName(String name)
      The name of the original data that this trace was plotted from or null

    • getData

      org.eclipse.january.dataset.IDataset getData()
      Call this method to return a plotted data set by this trace. Different trace types will return different ranks from getData(). For ILineTrace it is 1D line data For IImageTrace it is a 2D image etc.

    • isVisible

      boolean isVisible()
      True if visible
      Returns:

    • setVisible

      void setVisible(boolean isVisible)
      True if visible

    • isUserTrace

      boolean isUserTrace()
      True if user trace (normally is)
      Returns:

    • setUserTrace

      void setUserTrace(boolean isUserTrace)
      True if visible

    • getUserObject

      Object getUserObject()
      An object which may be set by API users to record information about the plot. Ideally avoid objects containing large data in this method.
      Returns:

    • setUserObject

      void setUserObject(Object userObject)
      An object which may be set by API users to record information about the plot. Ideally avoid objects containing large data in this method.

    • is3DTrace

      boolean is3DTrace()
      Returns:
      true if trace is plotted using a 3D viewer.

    • dispose

      void dispose()
      Called to release system resources.

    • getRank

      int getRank()
      The rank of data plotted, 1 for XY, 2 for Image and surfaces, 3 for volumes.
      Returns: