hep.aida
Interface IPlotterRegion

public interface IPlotterRegion

User level interface to a plotter region. A region is managed by a plotter. A region must be seen as a scene manager handling a custome "plotting" scene. In general this kind of scene may be in 2D or 3D. In 2D, the scene have "coarse graining parts" like two axis, data representations within the axis. It may have various other parts like a grid, a title, an info area. In 3D, the scene have in general three axis, a different global layout, some data representations within the axis area and also scene parts like title, grid, etc... To customize all these, some "style" interfaces had been introduced. In general there is one style interface per "scene part" ; then IAxisStyle, IDataStyle, ITitleStyle. Oftenly a "scene part" contains text, line, fill area, etc.... For example an "axis" have a line, ticks, text for tick labels, text for the label of the axis, the magnitude, etc... A "coarse graining scene part" style contains various accessor to "atomic" styles like IMarkerStyle, ILineStyle, IFillStyle that permits to build a "customization block" to modify a scene part. A global style "block", the IPlotterStyle, could be retreived from a plotting region. This global style block have accessors to the various "coarse graining scene parts" of the plotting scene. Through it, we hope to offer a lot of customization in a convenient way... The keywords "scene" and "part" had been borrowed from the OpenInventor terminology.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

void	applyStyle(IPlotterStyle style) Set the style of a region and apply it to scene objects.
String[]	availableParameterOptions(String parameter) Get available options for a parameter.
String[]	availableParameters() Get avaliable parameters.
void	clear() Clear the list of things to plot in the region.
IInfo	info() Return an IInfo object describing the info area.
IPlotterLayout	layout() To customize axis position,etc...
String	parameterValue(String parameter) Get value of a parameter.
void	plot(IBaseHistogram histogram) Add a data analysis object (histogram, function, cloud,...)
void	plot(IBaseHistogram histogram, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...)
void	plot(IBaseHistogram histogram, IPlotterStyle style, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IBaseHistogram histogram, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IDataPointSet dataPointSet) Add a data analysis object (histogram, function, cloud,...)
void	plot(IDataPointSet dataPointSet, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...)
void	plot(IDataPointSet dataPointSet, IPlotterStyle style, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IDataPointSet dataPointSet, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IFunction function) Add a data analysis object (histogram, function, cloud,...)
void	plot(IFunction function, IPlotterStyle style) Add a data analysis object (histogram, function, cloud,...)
void	plot(IFunction function, IPlotterStyle style, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IFunction function, String options) Add a data analysis object (histogram, function, cloud,...)
void	plot(IPlottable plottable) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, IPlotterStyle style) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, IPlotterStyle style, String options) Send a generic plottable object to the plotting region.
void	plot(IPlottable plottable, String options) Send a generic plottable object to the plotting region.
void	refresh() Refresh the plotter region graphic.
void	remove(IBaseHistogram histogram) Remove a data analysis object in the list of things to plot in the region.
void	remove(IDataPointSet dataPointSet) Remove a data analysis object in the list of things to plot in the region.
void	remove(IFunction function) Remove a data analysis object in the list of things to plot in the region.
void	remove(IPlottable plottable) Generic entry point to remove some plotted scene part.
void	setLayout(IPlotterLayout layout) To customize axis position,etc...
void	setParameter(String parameter) Set various plotting paramters for the region.
void	setParameter(String parameter, String options) Set various plotting paramters for the region.
void	setStyle(IPlotterStyle style) Set the style of a region.
void	setTitle(String title) Set the title of a region.
void	setXLimits() Set limit of an axis representation the region area.
void	setXLimits(double min) Set limit of an axis representation the region area.
void	setXLimits(double min, double max) Set limit of an axis representation the region area.
void	setYLimits() Set limit of an axis representation the region area.
void	setYLimits(double min) Set limit of an axis representation the region area.
void	setYLimits(double min, double max) Set limit of an axis representation the region area.
void	setZLimits() Set limit of an axis representation the region area.
void	setZLimits(double min) Set limit of an axis representation the region area.
void	setZLimits(double min, double max) Set limit of an axis representation the region area.
IPlotterStyle	style() Get the style of the region.
String	title() Get the title of the region.
double	xLimitMax() Get the max limit of x.
double	xLimitMin() Get the min limit of x.
double	yLimitMax() Get the max limit of y.
double	yLimitMin() Get the min limit of y.
double	zLimitMax() Get the max limit of z.
double	zLimitMin() Get the min limit of z.

Method Detail

plot

public void plot(IBaseHistogram histogram)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IBaseHistogram histogram,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IBaseHistogram histogram,
                 IPlotterStyle style)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IBaseHistogram histogram,
                 IPlotterStyle style,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IFunction function)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IFunction function,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IFunction function,
                 IPlotterStyle style)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IFunction function,
                 IPlotterStyle style,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IDataPointSet dataPointSet)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IDataPointSet dataPointSet,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IDataPointSet dataPointSet,
                 IPlotterStyle style)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IDataPointSet dataPointSet,
                 IPlotterStyle style,
                 String options)
          throws IllegalArgumentException

Add a data analysis object (histogram, function, cloud,...) in the list of things to plot in the region. Activate the underlying graphic toolkit in order to bring something in the screen window(s) attached to the plotter. It assumes that the plotter had been mapped on the screen with its show method.

Throws:

IllegalArgumentException

plot

public void plot(IPlottable plottable)
          throws IllegalArgumentException

Send a generic plottable object to the plotting region. See IPlottable for more.

Throws:

IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 String options)
          throws IllegalArgumentException

Send a generic plottable object to the plotting region. See IPlottable for more.

Throws:

IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 IPlotterStyle style)
          throws IllegalArgumentException

Send a generic plottable object to the plotting region. See IPlottable for more.

Throws:

IllegalArgumentException

plot

public void plot(IPlottable plottable,
                 IPlotterStyle style,
                 String options)
          throws IllegalArgumentException

Send a generic plottable object to the plotting region. See IPlottable for more.

Throws:

IllegalArgumentException

remove

public void remove(IBaseHistogram histogram)
            throws IllegalArgumentException

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Throws:

IllegalArgumentException

remove

public void remove(IFunction function)
            throws IllegalArgumentException

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Throws:

IllegalArgumentException

remove

public void remove(IDataPointSet dataPointSet)
            throws IllegalArgumentException

Remove a data analysis object in the list of things to plot in the region. Activate the graphic layer to update the screen window.

Throws:

IllegalArgumentException

remove

public void remove(IPlottable plottable)
            throws IllegalArgumentException

Generic entry point to remove some plotted scene part.

Throws:

IllegalArgumentException

clear

public void clear()

Clear the list of things to plot in the region. Clear the corresponding area on screen window(s).

refresh

public void refresh()
             throws RuntimeException

Refresh the plotter region graphic. Can be used when a plotted data analysis object received new data.

Throws:

RuntimeException

setParameter

public void setParameter(String parameter)
                  throws IllegalArgumentException

Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.

Throws:

IllegalArgumentException

setParameter

public void setParameter(String parameter,
                         String options)
                  throws IllegalArgumentException

Set various plotting paramters for the region. Activate the graphic layer and update the screen window(s) if needed.

Throws:

IllegalArgumentException

parameterValue

public String parameterValue(String parameter)

Get value of a parameter.

Parameters:

parameter - Name of the parameter.

Returns:

the value.

availableParameterOptions

public String[] availableParameterOptions(String parameter)

Get available options for a parameter.

Parameters:

parameter - Name of the parameter.

Returns:

options

availableParameters

public String[] availableParameters()

Get avaliable parameters.

Returns:

parameters

style

public IPlotterStyle style()

Get the style of the region.

setStyle

public void setStyle(IPlotterStyle style)
              throws IllegalArgumentException

Set the style of a region.

Throws:

IllegalArgumentException

applyStyle

public void applyStyle(IPlotterStyle style)
                throws IllegalArgumentException

Set the style of a region and apply it to scene objects.

Throws:

IllegalArgumentException

setTitle

public void setTitle(String title)

Set the title of a region.

title

public String title()

Get the title of the region.

setXLimits

public void setXLimits()
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setXLimits

public void setXLimits(double min)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setXLimits

public void setXLimits(double min,
                       double max)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setYLimits

public void setYLimits()
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setYLimits

public void setYLimits(double min)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setYLimits

public void setYLimits(double min,
                       double max)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setZLimits

public void setZLimits()
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setZLimits

public void setZLimits(double min)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

setZLimits

public void setZLimits(double min,
                       double max)
                throws IllegalArgumentException

Set limit of an axis representation the region area.

Throws:

IllegalArgumentException

xLimitMin

public double xLimitMin()

Get the min limit of x.

xLimitMax

public double xLimitMax()

Get the max limit of x.

yLimitMin

public double yLimitMin()

Get the min limit of y.

yLimitMax

public double yLimitMax()

Get the max limit of y.

zLimitMin

public double zLimitMin()

Get the min limit of z.

zLimitMax

public double zLimitMax()

Get the max limit of z.

layout

public IPlotterLayout layout()

To customize axis position,etc... Change object position in the scence.

setLayout

public void setLayout(IPlotterLayout layout)
               throws IllegalArgumentException

To customize axis position,etc... Change object position in the scence.

Throws:

IllegalArgumentException

info

public IInfo info()

Return an IInfo object describing the info area.