FreeHEP API
Version 3.0

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, IInfoStyle. 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)
           
 String[] availableParameters()
           
 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)
           
 void plot(IBaseHistogram histogram, IPlotterStyle style, String options)
           
 void plot(IBaseHistogram histogram, String options)
          Add a data analysis object (histogram, function, cloud,...)
 void plot(IDataPointSet dataPointSet)
           
 void plot(IDataPointSet dataPointSet, IPlotterStyle style)
           
 void plot(IDataPointSet dataPointSet, IPlotterStyle style, String options)
           
 void plot(IDataPointSet dataPointSet, String options)
           
 void plot(IFunction function)
           
 void plot(IFunction function, IPlotterStyle style)
           
 void plot(IFunction function, IPlotterStyle style, String options)
           
 void plot(IFunction function, String options)
           
 void remove(IBaseHistogram histogram)
          Remove a data analysis object in the list of things to plot in the region.
 void remove(IDataPointSet dataPointSet)
           
 void remove(IFunction function)
           
 void setLayout(IPlotterLayout layout)
           
 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()
           
 void setYLimits(double min)
           
 void setYLimits(double min, double max)
           
 void setZLimits()
           
 void setZLimits(double min)
           
 void setZLimits(double min, double max)
           
 IPlotterStyle style()
          Get the style of the region.
 

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.

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.

IllegalArgumentException

plot

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

plot

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

plot

public void plot(IFunction function)
          throws IllegalArgumentException
IllegalArgumentException

plot

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

plot

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

plot

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

plot

public void plot(IDataPointSet dataPointSet)
          throws IllegalArgumentException
IllegalArgumentException

plot

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

plot

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

plot

public void plot(IDataPointSet dataPointSet,
                 IPlotterStyle style,
                 String options)
          throws IllegalArgumentException
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.

IllegalArgumentException

remove

public void remove(IFunction function)
            throws IllegalArgumentException
IllegalArgumentException

remove

public void remove(IDataPointSet dataPointSet)
            throws IllegalArgumentException
IllegalArgumentException

clear

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


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.

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.

IllegalArgumentException

parameterValue

public String parameterValue(String parameter)
Get value of a parameter.

Returns:
the value.

availableParameterOptions

public String[] availableParameterOptions(String parameter)

availableParameters

public String[] availableParameters()

style

public IPlotterStyle style()
Get the style of the region.


setStyle

public void setStyle(IPlotterStyle style)
              throws IllegalArgumentException
Set the style of a region.

IllegalArgumentException

applyStyle

public void applyStyle(IPlotterStyle style)
                throws IllegalArgumentException
Set the style of a region and apply it to scene objects.

IllegalArgumentException

setTitle

public void setTitle(String title)
Set the title of a region.


setXLimits

public void setXLimits()
                throws IllegalArgumentException
Set limit of an axis representation the region area.

IllegalArgumentException

setXLimits

public void setXLimits(double min)
                throws IllegalArgumentException
Set limit of an axis representation the region area.

IllegalArgumentException

setXLimits

public void setXLimits(double min,
                       double max)
                throws IllegalArgumentException
Set limit of an axis representation the region area.

IllegalArgumentException

setYLimits

public void setYLimits()
                throws IllegalArgumentException
IllegalArgumentException

setYLimits

public void setYLimits(double min)
                throws IllegalArgumentException
IllegalArgumentException

setYLimits

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

setZLimits

public void setZLimits()
                throws IllegalArgumentException
IllegalArgumentException

setZLimits

public void setZLimits(double min)
                throws IllegalArgumentException
IllegalArgumentException

setZLimits

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

layout

public IPlotterLayout layout()
To customize axis position,etc... Change object position in the scence.


setLayout

public void setLayout(IPlotterLayout layout)
               throws IllegalArgumentException
IllegalArgumentException

info

public IInfo info()
Return an IInfo object describing the info area.


FreeHEP API
Version 3.0

Copyright © 2000-2002 AIDA Team, All Rights Reserved.