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

Interface ITraceSystem

All Known Subinterfaces:
IPlottingSystem<T>
All Known Implementing Classes:
AbstractPlottingSystem, PlottingSystemImpl, ThreadSafePlottingSystem
public interface ITraceSystem
No methods in this interface are thread safe.

  • Method Details

    • createImageTrace

      IImageTrace createImageTrace(String traceName)
      Creates a line trace used for 1D plotting. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createLineTrace

      ILineTrace createLineTrace(String traceName)
      Creates a line trace used for 1D plotting. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createVectorTrace

      IVectorTrace createVectorTrace(String traceName)
      Creates a vector trace which may be added to a 1D or 2D plot. The Vector trace will draw arrows over the plot at various locations.
      Parameters:
      traceName -
      Returns:

    • createSurfaceTrace

      ISurfaceTrace createSurfaceTrace(String traceName)
      Creates a surface trace used for 3D plotting. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createIsosurfaceTrace

      IIsosurfaceTrace createIsosurfaceTrace(String string)
      Parameters:
      string -
      Returns:

    • createVolumeRenderTrace

      IVolumeRenderTrace createVolumeRenderTrace(String string)
      Parameters:
      string -
      Returns:

    • createMulti2DTrace

      IMulti2DTrace createMulti2DTrace(String traceName)
      Creates a multi image trace. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createLineStackTrace

      ILineStackTrace createLineStackTrace(String traceName)
      Creates a stack trace used for 3D plotting. This does not add the trace or give it any data. A stack trace is a 3D set of lines.
      Parameters:
      traceName -
      Returns:

    • createScatter3DTrace

      IScatter3DTrace createScatter3DTrace(String traceName)
      Creates a scatter 3D plot trace used for 3D plotting. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createImageStackTrace

      IImageStackTrace createImageStackTrace(String traceName)
      Creates a stack trace used for 2D plotting. This does not add the trace or give it any data. A stack trace is a 3D set of images. Only one image is visible at a time in the 2D plot.
      Parameters:
      traceName -
      Returns:

    • createPlane3DTrace

      IPlane3DTrace createPlane3DTrace(String traceName)
      Creates a plane image trace used for 3D plotting. This does not add the trace or give it any data.
      Parameters:
      traceName -
      Returns:

    • createTrace

      <U extends ITrace> U createTrace(String traceName, Class<U> clazz)
      Creates a trace corresponding to given class/interface
      Parameters:
      traceName -
      clazz -
      Returns:

    • createTrace

      ITrace createTrace(String traceName)
      Create a trace best suited to current plot type
      Parameters:
      traceName -
      Returns:

    • getRegisteredTraceClasses

      List<Class<? extends ITrace>> getRegisteredTraceClasses()

    • addTrace

      void addTrace(ITrace trace)
      Adds and plots the trace. Not Thread safe
      Parameters:
      trace -

    • removeTrace

      void removeTrace(ITrace trace)
      Adds and plots the trace.
      Parameters:
      trace -

    • getTrace

      ITrace getTrace(String name)
      return a plotted trace by name.
      Parameters:
      name -
      Returns:

    • getTraces

      Collection<ITrace> getTraces()
      Call this method to retrieve what is currently plotted. See all ITraceListener.
      Returns:

    • clearTraces

      void clearTraces()
      Remove the currently plotted traces. Thread safe

    • getTraces

      Collection<ITrace> getTraces(Class<? extends ITrace> clazz)
      Call this method to retrieve what is currently plotted by trace type See all ITraceListener.
      Returns:

    • getTracesByClass

      default <T extends ITrace> Collection<T> getTracesByClass(Class<T> clazz)
      Call this method to retrieve what is currently plotted by trace type See all ITraceListener.
      Returns:

    • addTraceListener

      void addTraceListener(ITraceListener l)
      Add a listener to be notified of new traces plotted
      Parameters:
      l -

    • removeTraceListener

      void removeTraceListener(ITraceListener l)
      Remove listener to avoid memory leaks
      Parameters:
      l -

    • renameTrace

      void renameTrace(ITrace trace, String name) throws Exception
      Renames the trace, better than calling setName on the ITrace as the collection of traces is updated properly. No event will be fired.
      Throws:
      Exception

    • moveTrace

      void moveTrace(String oldName, String name)
      Moves the trace definition in the internal hastable. Used internally only - do not call.

    • isXFirst

      boolean isXFirst()
      For 1D plotting, if the first plot is the x-axis, returns true.
      Returns:

    • setXFirst

      void setXFirst(boolean xFirst)
      Set if the first plot is the x-axis.
      Parameters:
      xFirst -

    • fireWillPlot

      void fireWillPlot(TraceWillPlotEvent evt)
      Notify that the trace is about to plot. Internal use only.
      Parameters:
      evt -

    • fireTraceUpdated

      void fireTraceUpdated(TraceEvent evt)
      May be used to force a trace to fire update listeners in the plotting system. Internal use only.
      Parameters:
      evt -

    • fireTraceAdded

      void fireTraceAdded(TraceEvent evt)
      Call to notify that a trace has been added. Internal use only.
      Parameters:
      evt -