hep.lcd.util.aida
Interface IHistogramManager

All Known Subinterfaces:
Processor
All Known Implementing Classes:
AbstractProcessor, Driver, HistogramManager

public interface IHistogramManager

A convenience class for managing large number of histograms without having to carry around histogram factories and creating many member variables.

The HistogramManager should manage the histograms in such a way that filling them in the same order on subsequent iterations is efficient and does not involve looking each histogram up by name in the ITree.


Method Summary
 IAnalysisFactory analysisFactory()
          Get the ITree associated with this IHistogramManager
 ICloud1D cloud1D(java.lang.String path)
          Returns the named ICloud, or creates it if it does not exist.
 ICloud1D cloud1D(java.lang.String path, int nMax)
          Returns the named ICloud, or creates it if it does not exist.
 ICloud2D cloud2D(java.lang.String path)
          Returns the named ICloud, or creates it if it does not exist.
 ICloud2D cloud2D(java.lang.String path, int nMax)
          Returns the named ICloud, or creates it if it does not exist.
 ICloud3D cloud3D(java.lang.String path)
          Returns the named ICloud, or creates it if it does not exist.
 ICloud3D cloud3D(java.lang.String path, int nMax)
          Returns the named ICloud, or creates it if it does not exist.
 IHistogram1D histogram1D(java.lang.String path)
          Returns the named histogram.
 IHistogram1D histogram1D(java.lang.String path, int bins, double lowerEdge, double upperEdge)
          Returns the named histogram, or creates it if it does not exist.
 IHistogram2D histogram2D(java.lang.String path)
          Returns the named histogram.
 IHistogram2D histogram2D(java.lang.String path, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Returns the named histogram, or creates it if it does not exist.
 IHistogram3D histogram3D(java.lang.String path)
          Returns the named histogram.
 IHistogram3D histogram3D(java.lang.String path, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
          Returns the named histogram, or creates it if it does not exist.
 IHistogramFactory histogramFactory()
          Get the Histogram factory associated with this IHistogramManager
 IProfile1D profile1D(java.lang.String path)
          Returns the named histogram.
 IProfile1D profile1D(java.lang.String path, int nBins, double lowerEdge, double upperEdge)
          Returns the named histogram, or creates it if it does not exist.
 IProfile2D profile2D(java.lang.String path)
          Returns the named histogram.
 IProfile2D profile2D(java.lang.String path, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
          Returns the named histogram, or creates it if it does not exist.
 ITree tree()
          Get the ITree associated with this IHistogramManager
 

Method Detail

tree

public ITree tree()
Get the ITree associated with this IHistogramManager


analysisFactory

public IAnalysisFactory analysisFactory()
Get the ITree associated with this IHistogramManager


histogramFactory

public IHistogramFactory histogramFactory()
Get the Histogram factory associated with this IHistogramManager


cloud1D

public ICloud1D cloud1D(java.lang.String path)
Returns the named ICloud, or creates it if it does not exist.


cloud2D

public ICloud2D cloud2D(java.lang.String path)
Returns the named ICloud, or creates it if it does not exist.


cloud3D

public ICloud3D cloud3D(java.lang.String path)
Returns the named ICloud, or creates it if it does not exist.


cloud1D

public ICloud1D cloud1D(java.lang.String path,
                        int nMax)
Returns the named ICloud, or creates it if it does not exist.


cloud2D

public ICloud2D cloud2D(java.lang.String path,
                        int nMax)
Returns the named ICloud, or creates it if it does not exist.


cloud3D

public ICloud3D cloud3D(java.lang.String path,
                        int nMax)
Returns the named ICloud, or creates it if it does not exist.


histogram1D

public IHistogram1D histogram1D(java.lang.String path)
Returns the named histogram.

Throws:
java.lang.IllegalArgumentException - If the histogram does not exist.

histogram2D

public IHistogram2D histogram2D(java.lang.String path)
Returns the named histogram.

Throws:
java.lang.IllegalArgumentException - If the histogram does not exist.

histogram3D

public IHistogram3D histogram3D(java.lang.String path)
Returns the named histogram.

Throws:
java.lang.IllegalArgumentException - If the histogram does not exist.

histogram1D

public IHistogram1D histogram1D(java.lang.String path,
                                int bins,
                                double lowerEdge,
                                double upperEdge)
Returns the named histogram, or creates it if it does not exist.


histogram2D

public IHistogram2D histogram2D(java.lang.String path,
                                int nBinsX,
                                double lowerEdgeX,
                                double upperEdgeX,
                                int nBinsY,
                                double lowerEdgeY,
                                double upperEdgeY)
Returns the named histogram, or creates it if it does not exist.


histogram3D

public IHistogram3D histogram3D(java.lang.String path,
                                int nBinsX,
                                double lowerEdgeX,
                                double upperEdgeX,
                                int nBinsY,
                                double lowerEdgeY,
                                double upperEdgeY,
                                int nBinsZ,
                                double lowerEdgeZ,
                                double upperEdgeZ)
Returns the named histogram, or creates it if it does not exist.


profile1D

public IProfile1D profile1D(java.lang.String path)
Returns the named histogram.

Throws:
java.lang.IllegalArgumentException - If the histogram does not exist.

profile2D

public IProfile2D profile2D(java.lang.String path)
Returns the named histogram.

Throws:
java.lang.IllegalArgumentException - If the histogram does not exist.

profile1D

public IProfile1D profile1D(java.lang.String path,
                            int nBins,
                            double lowerEdge,
                            double upperEdge)
Returns the named histogram, or creates it if it does not exist.


profile2D

public IProfile2D profile2D(java.lang.String path,
                            int nBinsX,
                            double lowerEdgeX,
                            double upperEdgeX,
                            int nBinsY,
                            double lowerEdgeY,
                            double upperEdgeY)
Returns the named histogram, or creates it if it does not exist.