ISurfaceTrace

All Superinterfaces:: IAxesTrace, IImage3DTrace, org.eclipse.january.INameable, IPaletteTrace, ITrace, IWindowTrace

All Known Implementing Classes:: SurfaceTrace

public interface ISurfaceTrace extends IImage3DTrace, IWindowTrace

This interface is ready for use from now onwards and is to be used for 3D plotting operations. Use IImageTrace normally for images.

Method Summary

Modifier and Type

Method

Description

IROI

getWindow()

boolean

setData(org.eclipse.january.dataset.IDataset data, List<org.eclipse.january.dataset.IDataset> axes)

Set the data of the plot, will replot if called on an active plot.

org.eclipse.core.runtime.IStatus

setWindow(IROI window, boolean updateClipping, org.eclipse.core.runtime.IProgressMonitor monitor)

Set the window to be used as a SurfacePlotROI or RectangularROI

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.IAxesTrace
getAxes, getAxesNames, isActive

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.IImage3DTrace
setAxesNames

Methods inherited from interface org.eclipse.january.INameable
getName, setName

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.IPaletteTrace
addPaletteListener, getImageServiceBean, getMax, getMaxCut, getMin, getMinCut, getNanBound, getPaletteData, getPaletteName, isRescaleHistogram, removePaletteListener, setMax, setMaxCut, setMin, setMinCut, setNanBound, setPalette, setPaletteData, setPaletteName, setRescaleHistogram

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.ITrace
dispose, getData, getDataName, getRank, getUserObject, initialize, is3DTrace, isUserTrace, isVisible, setDataName, setUserObject, setUserTrace, setVisible

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.IWindowTrace
setWindow

Method Details
- setData
  
  boolean setData(org.eclipse.january.dataset.IDataset data, List<org.eclipse.january.dataset.IDataset> axes)
  
  Set the data of the plot, will replot if called on an active plot.
  
  Parameters:
  
  data -
  
  axes -
  
  Returns:
  
  true if data has been successfully set
  
  Throws:
  
  Exception
- getWindow
  
  IROI getWindow()
  
  Returns:
  
  the region of the window, usually a SurfacePlotROI or a RectangularROI
- setWindow
  
  org.eclipse.core.runtime.IStatus setWindow(IROI window, boolean updateClipping, org.eclipse.core.runtime.IProgressMonitor monitor)
  
  Set the window to be used as a SurfacePlotROI or RectangularROI
  
  Parameters:
  
  window -
  
  updateClipping -
  
  monitor -
  
  Returns:
  
  status