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

Interface ILineStackTrace

All Superinterfaces:

IAxesTrace, org.eclipse.january.INameable, ITrace, IWindowTrace

All Known Implementing Classes:

StackTrace

public interface ILineStackTrace
extends IAxesTrace, IWindowTrace

Interface for plotting stack of plots in 3D. For plotting a stack of plots in 1D, staggered in Z. This interface is for stacks in 3D and is more limited because of the features available in the 3D viewer. If all the tools are required, use createPlot1D(x, manyYs, ...) where manyYs is a stack of 1D data. This will all be plotted in an overlayed manner but allow all tools to be used.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXIMUM_STACK	Maximum number of stack plots used for the stack window slicing tool

Method Summary

Modifier and Type	Method	Description
org.eclipse.january.dataset.IDataset	getData()	For IStackTrace, calling this method will throw a RuntimeException all the time which ask you to use getStack() instead.
org.eclipse.january.dataset.IDataset[]	getStack()	The stack that is being plotted.
IROI	getWindow()
void	setAxesNames(List<String> axesNames)
void	setData(List<? extends org.eclipse.january.dataset.IDataset> axes, org.eclipse.january.dataset.IDataset... stack)	Set the data of the plot, will re-plot if called on an active plot.
void	setWindow(IROI window)	Set the window to be used as a LinearROI.

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.IAxesTrace

getAxes, getAxesNames, isActive

Methods inherited from interface org.eclipse.january.INameable

getName, setName

Methods inherited from interface org.eclipse.dawnsci.plotting.api.trace.ITrace

dispose, getDataName, getRank, getUserObject, initialize, is3DTrace, isUserTrace, isVisible, setDataName, setUserObject, setUserTrace, setVisible

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

setWindow

Field Details

MAXIMUM_STACK

static final int MAXIMUM_STACK

Maximum number of stack plots used for the stack window slicing tool

See Also:

• Constant Field Values

Method Details

getData

org.eclipse.january.dataset.IDataset getData()
                                      throws RuntimeException

For IStackTrace, calling this method will throw a RuntimeException all the time which ask you to use getStack() instead.

Specified by:

getData in interface ITrace

Throws:

RuntimeException

setData

void setData(List<? extends org.eclipse.january.dataset.IDataset> axes,
 org.eclipse.january.dataset.IDataset... stack)

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

Parameters:

axes -

data -

Throws:

Exception

getStack

org.eclipse.january.dataset.IDataset[] getStack()

The stack that is being plotted.

Returns:

setAxesNames

void setAxesNames(List<String> axesNames)

Parameters:

axesNames -

getWindow

IROI getWindow()

Returns:

the region of the window, usually a LinearROI

setWindow

void setWindow(IROI window)

Set the window to be used as a LinearROI. The first x value is the start of the window, the second x value is the end. the y values are ignored. This window is used to filter down the number of lines in the stack to avoid it getting to large for the 3D plotter.

Parameters:

window -