hep.analysis
Class Plot

java.lang.Object
  |
  +--hep.analysis.AbstractNamedObject
        |
        +--hep.analysis.Plot

All Implemented Interfaces:

NamedObject, java.io.Serializable

public class Plot

extends AbstractNamedObject

A Plot represents a plot which can be seen by the user. One or more Histograms (or Histogram subclasses such as ScatterPlot) can be added to a plot. In addition the Page class can be used to arrange multiple plots on a Page.

See Also:

Page.add(Plot), Page.remove(Plot), Serialized Form

Inner classes inherited from class hep.analysis.NamedObject

NamedObject.RenameException

Fields inherited from class hep.analysis.AbstractNamedObject

m_parent

Constructor Summary

Plot(java.lang.String name)

Plot(java.lang.String name, Folder parent)

Method Summary

void	add(Histogram h) Add a histogram to the plot.
void	clear() Clear all the histograms from the plot
protected Folder	getDefaultParent() Get default parent is called when an object is read in with no parent Folder.
Histogram	getHistogram(int index) Return the histograms available on this plot
int	getNHistograms() Return the number of histograms available on this plot
void	remove(Histogram h) Remove a histogram from the plot.
void	show() Requests that this plot be made visible to the user.
java.lang.String	toString()

Methods inherited from class hep.analysis.AbstractNamedObject

delete, getFolder, getName, rename

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Plot

public Plot(java.lang.String name)

Plot

public Plot(java.lang.String name,
            Folder parent)

Method Detail

add

public void add(Histogram h)

Add a histogram to the plot. Adding multiple histograms to a plot will cause them to be overlayed.

getNHistograms

public int getNHistograms()

Return the number of histograms available on this plot

getHistogram

public Histogram getHistogram(int index)

Return the histograms available on this plot

remove

public void remove(Histogram h)

Remove a histogram from the plot.

clear

public void clear()

Clear all the histograms from the plot

show

public void show()

Requests that this plot be made visible to the user. The effectiveness of the request will depend on the environment in which the job is running.

getDefaultParent

protected Folder getDefaultParent()

Description copied from class: AbstractNamedObject

Get default parent is called when an object is read in with no parent Folder. Concrete classes must provide an implementation of this method.

Overrides:

getDefaultParent in class AbstractNamedObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object