hep.aida
Interface IHistogramFactory

public interface IHistogramFactory

User level interface for factory classes of Histograms (binned, unbinned, and profile) The created objects are assumed to be managed by the tree which is associated to the factory.

Author:

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

Method Summary

IHistogram1D	add(String name, IHistogram1D hist1, IHistogram1D hist2) Create an IHistogram1D by adding two IHistogram1D.
IHistogram2D	add(String name, IHistogram2D hist1, IHistogram2D hist2) Create an IHistogram2D by adding two IHistogram2D.
IHistogram3D	add(String name, IHistogram3D hist1, IHistogram3D hist2) Create an IHistogram3D by adding two IHistogram3D.
ICloud1D	createCloud1D(String nameAndTitle) Create a ICloud1D, an unbinned 1-dimensional histogram.
ICloud1D	createCloud1D(String name, String title) Create a ICloud1D, an unbinned 1-dimensioal histogram.
ICloud1D	createCloud1D(String name, String title, int nMax) Create a ICloud1D, an unbinned 1-dimensioal histogram.
ICloud1D	createCloud1D(String name, String title, int nMax, String options) Create a ICloud1D, an unbinned 1-dimensioal histogram.
ICloud2D	createCloud2D(String nameAndTitle) Create a ICloud2D, an unbinned 2-dimensional histogram.
ICloud2D	createCloud2D(String name, String title) Create a ICloud2D, an unbinned 2-dimensional histogram.
ICloud2D	createCloud2D(String name, String title, int nMax) Create a ICloud2D, an unbinned 2-dimensional histogram.
ICloud2D	createCloud2D(String name, String title, int nMax, String options) Create a ICloud2D, an unbinned 2-dimensional histogram.
ICloud3D	createCloud3D(String nameAndTitle) Create a ICloud3D, an unbinned 3-dimensional histogram.
ICloud3D	createCloud3D(String name, String title) Create a ICloud3D, an unbinned 3-dimensional histogram.
ICloud3D	createCloud3D(String name, String title, int nMax) Create a ICloud3D, an unbinned 3-dimensional histogram.
ICloud3D	createCloud3D(String name, String title, int nMax, String options) Create a ICloud3D, an unbinned 3-dimensional histogram.
ICloud1D	createCopy(String name, ICloud1D cloud) Create a copy of an ICloud1D.
ICloud2D	createCopy(String name, ICloud2D cloud) Create a copy of an ICloud2D.
ICloud3D	createCopy(String name, ICloud3D cloud) Create a copy of an ICloud3D.
IHistogram1D	createCopy(String name, IHistogram1D hist) Create a copy of an IHistogram1D.
IHistogram2D	createCopy(String name, IHistogram2D hist) Create a copy of an IHistogram2D.
IHistogram3D	createCopy(String name, IHistogram3D hist) Create a copy of an IHistogram3D.
IProfile1D	createCopy(String name, IProfile1D profile) Create a copy of an IProfile1D.
IProfile2D	createCopy(String name, IProfile2D profile) Create a copy of an IProfile2D.
IHistogram1D	createHistogram1D(String nameAndTitle, int nBins, double lowerEdge, double upperEdge) Create a IHistogram1D.
IHistogram1D	createHistogram1D(String name, String title, double[] binEdges) Create a IHistogram1D.
IHistogram1D	createHistogram1D(String name, String title, double[] binEdges, String options) Create a IHistogram1D.
IHistogram1D	createHistogram1D(String name, String title, int nBins, double lowerEdge, double upperEdge) Create a IHistogram1D.
IHistogram1D	createHistogram1D(String name, String title, int nBins, double lowerEdge, double upperEdge, String options) Create a IHistogram1D.
IHistogram2D	createHistogram2D(String nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) Create a IHistogram2D.
IHistogram2D	createHistogram2D(String name, String title, double[] binEdgesX, double[] binEdgesY) Create a IHistogram2D.
IHistogram2D	createHistogram2D(String name, String title, double[] binEdgesX, double[] binEdgesY, String options) Create a IHistogram2D.
IHistogram2D	createHistogram2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) Create a IHistogram2D.
IHistogram2D	createHistogram2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, String options) Create a IHistogram2D.
IHistogram3D	createHistogram3D(String nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) Create a IHistogram3D.
IHistogram3D	createHistogram3D(String name, String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ) Create a IHistogram3D.
IHistogram3D	createHistogram3D(String name, String title, double[] binEdgesX, double[] binEdgesY, double[] binEdgesZ, String options) Create a IHistogram3D.
IHistogram3D	createHistogram3D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ) Create a IHistogram3D.
IHistogram3D	createHistogram3D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, String options) Create a IHistogram3D.
IProfile1D	createProfile1D(String nameAndTitle, int nBins, double lowerEdge, double upperEdge) Create a IProfile1D.
IProfile1D	createProfile1D(String nameAndTitle, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, double[] binEdges) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, double[] binEdges, double lowerValue, double upperValue) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, double[] binEdges, double lowerValue, double upperValue, String options) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, double[] binEdges, String options) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, int nBins, double lowerEdge, double upperEdge) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, int nBins, double lowerEdge, double upperEdge, double lowerValue, double upperValue, String options) Create a IProfile1D.
IProfile1D	createProfile1D(String name, String title, int nBins, double lowerEdge, double upperEdge, String options) Create a IProfile1D.
IProfile2D	createProfile2D(String nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) Create a IProfile2D.
IProfile2D	createProfile2D(String nameAndTitle, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, double[] binEdgesX, double[] binEdgesY) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, double[] binEdgesX, double[] binEdgesY, double lowerValue, double upperValue, String options) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, double[] binEdgesX, double[] binEdgesY, String options) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, double lowerValue, double upperValue, String options) Create a IProfile2D.
IProfile2D	createProfile2D(String name, String title, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, String options) Create a IProfile2D.
void	destroy(IBaseHistogram hist) Destroy an IBaseHistogram ogject.
IHistogram1D	divide(String name, IHistogram1D hist1, IHistogram1D hist2) Create an IHistogram1D by dividing two IHistogram1D.
IHistogram2D	divide(String name, IHistogram2D hist1, IHistogram2D hist2) Create an IHistogram2D by dividing two IHistogram2D.
IHistogram3D	divide(String name, IHistogram3D hist1, IHistogram3D hist2) Create an IHistogram3D by dividing two IHistogram3D.
IHistogram1D	multiply(String name, IHistogram1D hist1, IHistogram1D hist2) Create an IHistogram1D by multiplying two IHistogram1D.
IHistogram2D	multiply(String name, IHistogram2D hist1, IHistogram2D hist2) Create an IHistogram2D by multiplying two IHistogram2D.
IHistogram3D	multiply(String name, IHistogram3D hist1, IHistogram3D hist2) Create an IHistogram3D by multiplying two IHistogram3D.
IHistogram1D	projectionX(String name, IHistogram2D hist) Create an IHistogram1D by projecting an IHistogram2D along its x axis.
IHistogram2D	projectionXY(String name, IHistogram3D hist) Create an IHistogram2D by projecting an IHistogram3D on the x-y plane.
IHistogram2D	projectionXZ(String name, IHistogram3D hist) Create an IHistogram2D by projecting an IHistogram3D on the x-z plane.
IHistogram1D	projectionY(String name, IHistogram2D hist) Create an IHistogram1D by projecting an IHistogram2D along its y axis.
IHistogram2D	projectionYZ(String name, IHistogram3D hist) Create an IHistogram2D by projecting an IHistogram3D on the y-z plane.
IHistogram1D	sliceX(String name, IHistogram2D hist, int index) Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin.
IHistogram1D	sliceX(String name, IHistogram2D hist, int index1, int index2) Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).
IHistogram2D	sliceXY(String name, IHistogram3D hist, int index1, int index2) Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Z axis, between "index1" and "index2" (inclusive).
IHistogram2D	sliceXZ(String name, IHistogram3D hist, int index1, int index2) Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Y axis, between "index1" and "index2" (inclusive).
IHistogram1D	sliceY(String name, IHistogram2D hist, int index) Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin.
IHistogram1D	sliceY(String name, IHistogram2D hist, int index1, int index2) Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).
IHistogram2D	sliceYZ(String name, IHistogram3D hist, int index1, int index2) Create an IHistogram2D by slicing an IHistogram3D perpendicular to the X axis, between "index1" and "index2" (inclusive).
IHistogram1D	subtract(String name, IHistogram1D hist1, IHistogram1D hist2) Create an IHistogram1D by subtracting two IHistogram1D.
IHistogram2D	subtract(String name, IHistogram2D hist1, IHistogram2D hist2) Create an IHistogram2D by subtracting two IHistogram2D.
IHistogram3D	subtract(String name, IHistogram3D hist1, IHistogram3D hist2) Create an IHistogram3D by subtracting two IHistogram3D.

Method Detail

destroy

public void destroy(IBaseHistogram hist)
             throws IllegalArgumentException

Destroy an IBaseHistogram ogject.

Parameters:

hist - The IBaseHistogram to be destroyed.

Throws:

IllegalArgumentException - If the histogram cannot be destroyed.

createCloud1D

public ICloud1D createCloud1D(String name,
                              String title)

Create a ICloud1D, an unbinned 1-dimensioal histogram.

Parameters:

name - The name of the ICloud1D.

title - The title of the ICloud1D. will convert to an IHistogram1D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram1D. to an IHistogram1D.

Returns:

The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String name,
                              String title,
                              int nMax)

Create a ICloud1D, an unbinned 1-dimensioal histogram.

Parameters:

name - The name of the ICloud1D.

title - The title of the ICloud1D.

nMax - The maximum number of entries after which the ICloud1D will convert to an IHistogram1D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram1D. to an IHistogram1D.

Returns:

The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String name,
                              String title,
                              int nMax,
                              String options)

Create a ICloud1D, an unbinned 1-dimensioal histogram.

Parameters:

name - The name of the ICloud1D.

title - The title of the ICloud1D.

nMax - The maximum number of entries after which the ICloud1D will convert to an IHistogram1D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram1D.

options - The options for the ICloud1D. "autoconvert=true" to enable autoconversion to an IHistogram1D.

Returns:

The newly created ICloud1D.

createCloud1D

public ICloud1D createCloud1D(String nameAndTitle)

Create a ICloud1D, an unbinned 1-dimensional histogram.

Parameters:

nameAndTitle - The name of the ICloud1D; it is also its title.

Returns:

The newly created ICloud1D.

createCopy

public ICloud1D createCopy(String name,
                           ICloud1D cloud)

Create a copy of an ICloud1D.

Parameters:

name - The name of the new copy.

cloud - The ICloud1D to be copied.

Returns:

The copy of the ICloud1D.

createCloud2D

public ICloud2D createCloud2D(String name,
                              String title)

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:

name - The name of the ICloud2D.

title - The title of the ICloud2D. will convert to an IHistogram2D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram2D. to an IHistogram2D.

Returns:

The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String name,
                              String title,
                              int nMax)

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:

name - The name of the ICloud2D.

title - The title of the ICloud2D.

nMax - The maximum number of entries after which the ICloud2D will convert to an IHistogram2D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram2D. to an IHistogram2D.

Returns:

The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String name,
                              String title,
                              int nMax,
                              String options)

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:

name - The name of the ICloud2D.

title - The title of the ICloud2D.

nMax - The maximum number of entries after which the ICloud2D will convert to an IHistogram2D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram2D.

options - The options for the ICloud2D. "autoconvert=true" to enable autoconversion to an IHistogram2D.

Returns:

The newly created ICloud2D.

createCloud2D

public ICloud2D createCloud2D(String nameAndTitle)

Create a ICloud2D, an unbinned 2-dimensional histogram.

Parameters:

nameAndTitle - The name of the ICloud2D; it is also its title.

Returns:

The newly created ICloud2D.

createCopy

public ICloud2D createCopy(String name,
                           ICloud2D cloud)

Create a copy of an ICloud2D.

Parameters:

name - The name of the new copy.

cloud - The ICloud2D to be copied.

Returns:

The copy of the ICloud2D.

createCloud3D

public ICloud3D createCloud3D(String name,
                              String title)

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:

name - The name of the ICloud3D.

title - The title of the ICloud3D. will convert to an IHistogram3D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram3D. to an IHistogram3D.

Returns:

The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String name,
                              String title,
                              int nMax)

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:

name - The name of the ICloud3D.

title - The title of the ICloud3D.

nMax - The maximum number of entries after which the ICloud3D will convert to an IHistogram3D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram3D. to an IHistogram3D.

Returns:

The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String name,
                              String title,
                              int nMax,
                              String options)

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:

name - The name of the ICloud3D.

title - The title of the ICloud3D.

nMax - The maximum number of entries after which the ICloud3D will convert to an IHistogram3D. The default nMax = -1 indicates no limit of entries before aoutoconversion to a IHistogram3D.

options - The options for the ICloud3D. "autoconvert=true" to enable autoconversion to an IHistogram3D.

Returns:

The newly created ICloud3D.

createCloud3D

public ICloud3D createCloud3D(String nameAndTitle)

Create a ICloud3D, an unbinned 3-dimensional histogram.

Parameters:

nameAndTitle - The name of the ICloud3D; it is also its title.

Returns:

The newly created ICloud3D.

createCopy

public ICloud3D createCopy(String name,
                           ICloud3D cloud)

Create a copy of an ICloud3D.

Parameters:

name - The name of the new copy.

cloud - The ICloud3D to be copied.

Returns:

The copy of the ICloud3D.

createHistogram1D

public IHistogram1D createHistogram1D(String name,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)

Create a IHistogram1D.

Parameters:

name - The name of the IHistogram1D.

title - The title of the IHistogram1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis. "type=efficiency" for an efficiency IHistogram1D.

Returns:

The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String name,
                                      String title,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge,
                                      String options)

Create a IHistogram1D.

Parameters:

name - The name of the IHistogram1D.

title - The title of the IHistogram1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

options - The options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D.

Returns:

The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String nameAndTitle,
                                      int nBins,
                                      double lowerEdge,
                                      double upperEdge)

Create a IHistogram1D.

Parameters:

nameAndTitle - The name of the IHistogram1D; it is also the title.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

Returns:

The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String name,
                                      String title,
                                      double[] binEdges)

Create a IHistogram1D.

Parameters:

name - The name of the IHistogram1D.

title - The title of the IHistogram1D.

binEdges - The array of the bin edges for the x axis. "type=efficiency" for an efficiency IHistogram1D.

Returns:

The newly created IHistogram1D.

createHistogram1D

public IHistogram1D createHistogram1D(String name,
                                      String title,
                                      double[] binEdges,
                                      String options)

Create a IHistogram1D.

Parameters:

name - The name of the IHistogram1D.

title - The title of the IHistogram1D.

binEdges - The array of the bin edges for the x axis.

options - The options for the IHistogram1D. The default is "". "type=efficiency" for an efficiency IHistogram1D.

Returns:

The newly created IHistogram1D.

createCopy

public IHistogram1D createCopy(String name,
                               IHistogram1D hist)

Create a copy of an IHistogram1D.

Parameters:

name - The name of the new copy.

hist - The IHistogram1D to be copied.

Returns:

The copy of the IHistogram1D.

createHistogram2D

public IHistogram2D createHistogram2D(String name,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY)

Create a IHistogram2D.

Parameters:

name - The name of the IHistogram2D.

title - The title of the IHistogram2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis. "type=efficiency" for an efficiency IHistogram2D.

Returns:

The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String name,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      String options)

Create a IHistogram2D.

Parameters:

name - The name of the IHistogram2D.

title - The title of the IHistogram2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

options - The options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D.

Returns:

The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String nameAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY)

Create a IHistogram2D.

Parameters:

nameAndTitle - The name of the IHistogram2D; it is also the title.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

Returns:

The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String name,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY)

Create a IHistogram2D.

Parameters:

name - The name of the IHistogram2D.

title - The title of the IHistogram2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis. "type=efficiency" for an efficiency IHistogram2D.

Returns:

The newly created IHistogram2D.

createHistogram2D

public IHistogram2D createHistogram2D(String name,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      String options)

Create a IHistogram2D.

Parameters:

name - The name of the IHistogram2D.

title - The title of the IHistogram2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

options - The options for the IHistogram2D. The default is "". "type=efficiency" for an efficiency IHistogram2D.

Returns:

The newly created IHistogram2D.

createCopy

public IHistogram2D createCopy(String name,
                               IHistogram2D hist)

Create a copy of an IHistogram2D.

Parameters:

name - The name of the new copy.

hist - The IHistogram2D to be copied.

Returns:

The copy of the IHistogram2D.

createHistogram3D

public IHistogram3D createHistogram3D(String name,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ)

Create a IHistogram3D.

Parameters:

name - The name of the IHistogram3D.

title - The title of the IHistogram3D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

nBinsZ - The number of bins of the z axis.

lowerEdgeZ - The lower edge of the z axis.

upperEdgeZ - The upper edge of the z axis. "type=efficiency" for an efficiency IHistogram3D.

Returns:

The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String name,
                                      String title,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ,
                                      String options)

Create a IHistogram3D.

Parameters:

name - The name of the IHistogram3D.

title - The title of the IHistogram3D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

nBinsZ - The number of bins of the z axis.

lowerEdgeZ - The lower edge of the z axis.

upperEdgeZ - The upper edge of the z axis.

options - The options for the IHistogram3D. The default is "". "type=efficiency" for an efficiency IHistogram3D.

Returns:

The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String nameAndTitle,
                                      int nBinsX,
                                      double lowerEdgeX,
                                      double upperEdgeX,
                                      int nBinsY,
                                      double lowerEdgeY,
                                      double upperEdgeY,
                                      int nBinsZ,
                                      double lowerEdgeZ,
                                      double upperEdgeZ)

Create a IHistogram3D.

Parameters:

nameAndTitle - The name of the IHistogram3D; it is also the title.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

nBinsZ - The number of bins of the z axis.

lowerEdgeZ - The lower edge of the z axis.

upperEdgeZ - The upper edge of the z axis.

Returns:

The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String name,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ)

Create a IHistogram3D.

Parameters:

name - The name of the IHistogram3D.

title - The title of the IHistogram3D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

binEdgesZ - The array of the bin edges for the z axis. "type=efficiency" for an efficiency IHistogram3D.

Returns:

The newly created IHistogram3D.

createHistogram3D

public IHistogram3D createHistogram3D(String name,
                                      String title,
                                      double[] binEdgesX,
                                      double[] binEdgesY,
                                      double[] binEdgesZ,
                                      String options)

Create a IHistogram3D.

Parameters:

name - The name of the IHistogram3D.

title - The title of the IHistogram3D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

binEdgesZ - The array of the bin edges for the z axis.

options - The options for the IHistogram3D. The default is "". "type=efficiency" for an efficiency IHistogram3D.

Returns:

The newly created IHistogram3D.

createCopy

public IHistogram3D createCopy(String name,
                               IHistogram3D hist)

Create a copy of an IHistogram3D.

Parameters:

name - The name of the new copy.

hist - The IHistogram3D to be copied.

Returns:

The copy of the IHistogram3D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  String options)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

options - The options for the IProfile1D. The default is "".

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue,
                                  String options)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

options - The options for the IProfile1D. The default is "".

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  double[] binEdges)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

binEdges - The array of the bin edges for the x axis.

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  double[] binEdges,
                                  String options)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

binEdges - The array of the bin edges for the x axis.

options - The options for the IProfile1D. The default is "".

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

binEdges - The array of the bin edges for the x axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String name,
                                  String title,
                                  double[] binEdges,
                                  double lowerValue,
                                  double upperValue,
                                  String options)

Create a IProfile1D.

Parameters:

name - The name of the IProfile1D.

title - The title of the IProfile1D.

binEdges - The array of the bin edges for the x axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

options - The options for the IProfile1D. The default is "".

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String nameAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge)

Create a IProfile1D.

Parameters:

nameAndTitle - The name of the IProfile1D; it is also the title.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

Returns:

The newly created IProfile1D.

createProfile1D

public IProfile1D createProfile1D(String nameAndTitle,
                                  int nBins,
                                  double lowerEdge,
                                  double upperEdge,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile1D.

Parameters:

nameAndTitle - The name of the IProfile1D; it is also the title.

nBins - The number of bins of the x axis.

lowerEdge - The lower edge of the x axis.

upperEdge - The upper edge of the x axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

Returns:

The newly created IProfile1D.

createCopy

public IProfile1D createCopy(String name,
                             IProfile1D profile)

Create a copy of an IProfile1D.

Parameters:

name - The name of the new copy.

profile - The IProfile1D to be copied.

Returns:

The copy of the IProfile1D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  String options)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

options - The options for the IProfile2D. The default is "".

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

lowerValue - The lower value displayed along the z axis.

upperValue - The upper value displayed along the z axis.

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue,
                                  String options)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

lowerValue - The lower value displayed along the z axis.

upperValue - The upper value displayed along the z axis.

options - The options for the IProfile2D. The default is "".

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  String options)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

options - The options for the IProfile2D. The default is "".

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String name,
                                  String title,
                                  double[] binEdgesX,
                                  double[] binEdgesY,
                                  double lowerValue,
                                  double upperValue,
                                  String options)

Create a IProfile2D.

Parameters:

name - The name of the IProfile2D.

title - The title of the IProfile2D.

binEdgesX - The array of the bin edges for the x axis.

binEdgesY - The array of the bin edges for the y axis.

lowerValue - The lower value displayed along the y axis.

upperValue - The upper value displayed along the y axis.

options - The options for the IProfile2D. The default is "".

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String nameAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY)

Create a IProfile2D.

Parameters:

nameAndTitle - The name of the IProfile2D; it is also the title.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

Returns:

The newly created IProfile2D.

createProfile2D

public IProfile2D createProfile2D(String nameAndTitle,
                                  int nBinsX,
                                  double lowerEdgeX,
                                  double upperEdgeX,
                                  int nBinsY,
                                  double lowerEdgeY,
                                  double upperEdgeY,
                                  double lowerValue,
                                  double upperValue)

Create a IProfile2D.

Parameters:

nameAndTitle - The name of the IProfile2D; it is also the title.

nBinsX - The number of bins of the x axis.

lowerEdgeX - The lower edge of the x axis.

upperEdgeX - The upper edge of the x axis.

nBinsY - The number of bins of the y axis.

lowerEdgeY - The lower edge of the y axis.

upperEdgeY - The upper edge of the y axis.

lowerValue - The lower value displayed along the z axis.

upperValue - The upper value displayed along the z axis.

Returns:

The newly created IProfile2D.

createCopy

public IProfile2D createCopy(String name,
                             IProfile2D profile)

Create a copy of an IProfile2D.

Parameters:

name - The name of the new copy.

profile - The IProfile2D to be copied.

Returns:

The copy of the IProfile2D.

add

public IHistogram1D add(String name,
                        IHistogram1D hist1,
                        IHistogram1D hist2)
                 throws IllegalArgumentException

Create an IHistogram1D by adding two IHistogram1D.

Parameters:

name - The name of the resulting IHistogram1D.

hist1 - The first member of the addition.

hist2 - The second member of the addition.

Returns:

The sum of the two IHistogram1D.

Throws:

IllegalArgumentException - if the two IHistogram1D have incompatible binning.

subtract

public IHistogram1D subtract(String name,
                             IHistogram1D hist1,
                             IHistogram1D hist2)
                      throws IllegalArgumentException

Create an IHistogram1D by subtracting two IHistogram1D.

Parameters:

name - The name of the resulting IHistogram1D.

hist1 - The first member of the subtraction.

hist2 - The second member of the subtraction.

Returns:

The difference of the two IHistogram1D.

Throws:

IllegalArgumentException - if the two IHistogram1D have incompatible binning.

multiply

public IHistogram1D multiply(String name,
                             IHistogram1D hist1,
                             IHistogram1D hist2)
                      throws IllegalArgumentException

Create an IHistogram1D by multiplying two IHistogram1D.

Parameters:

name - The name of the resulting IHistogram1D.

hist1 - The first member of the multiplication.

hist2 - The second member of the multiplication.

Returns:

The product of the two IHistogram1D.

Throws:

IllegalArgumentException - if the two IHistogram1D have incompatible binning.

divide

public IHistogram1D divide(String name,
                           IHistogram1D hist1,
                           IHistogram1D hist2)
                    throws IllegalArgumentException

Create an IHistogram1D by dividing two IHistogram1D.

Parameters:

name - The name of the resulting IHistogram1D.

hist1 - The first member of the division.

hist2 - The second member of the division.

Returns:

The ration of the two IHistogram1D.

Throws:

IllegalArgumentException - if the two IHistogram1D have incompatible binning.

add

public IHistogram2D add(String name,
                        IHistogram2D hist1,
                        IHistogram2D hist2)
                 throws IllegalArgumentException

Create an IHistogram2D by adding two IHistogram2D.

Parameters:

name - The name of the resulting IHistogram2D.

hist1 - The first member of the addition.

hist2 - The second member of the addition.

Returns:

The sum of the two IHistogram2D.

Throws:

IllegalArgumentException - if the two IHistogram2D have incompatible binning.

subtract

public IHistogram2D subtract(String name,
                             IHistogram2D hist1,
                             IHistogram2D hist2)
                      throws IllegalArgumentException

Create an IHistogram2D by subtracting two IHistogram2D.

Parameters:

name - The name of the resulting IHistogram2D.

hist1 - The first member of the subtraction.

hist2 - The second member of the subtraction.

Returns:

The difference of the two IHistogram2D.

Throws:

IllegalArgumentException - if the two IHistogram2D have incompatible binning.

multiply

public IHistogram2D multiply(String name,
                             IHistogram2D hist1,
                             IHistogram2D hist2)
                      throws IllegalArgumentException

Create an IHistogram2D by multiplying two IHistogram2D.

Parameters:

name - The name of the resulting IHistogram2D.

hist1 - The first member of the multiplication.

hist2 - The second member of the multiplication.

Returns:

The product of the two IHistogram2D.

Throws:

IllegalArgumentException - if the two IHistogram2D have incompatible binning.

divide

public IHistogram2D divide(String name,
                           IHistogram2D hist1,
                           IHistogram2D hist2)
                    throws IllegalArgumentException

Create an IHistogram2D by dividing two IHistogram2D.

Parameters:

name - The name of the resulting IHistogram2D.

hist1 - The first member of the division.

hist2 - The second member of the division.

Returns:

The ration of the two IHistogram2D.

Throws:

IllegalArgumentException - if the two IHistogram2D have incompatible binning.

add

public IHistogram3D add(String name,
                        IHistogram3D hist1,
                        IHistogram3D hist2)
                 throws IllegalArgumentException

Create an IHistogram3D by adding two IHistogram3D.

Parameters:

name - The name of the resulting IHistogram3D.

hist1 - The first member of the addition.

hist2 - The second member of the addition.

Returns:

The sum of the two IHistogram3D.

Throws:

IllegalArgumentException - if the two IHistogram3D have incompatible binning.

subtract

public IHistogram3D subtract(String name,
                             IHistogram3D hist1,
                             IHistogram3D hist2)
                      throws IllegalArgumentException

Create an IHistogram3D by subtracting two IHistogram3D.

Parameters:

name - The name of the resulting IHistogram3D.

hist1 - The first member of the subtraction.

hist2 - The second member of the subtraction.

Returns:

The difference of the two IHistogram3D.

Throws:

IllegalArgumentException - if the two IHistogram3D have incompatible binning.

multiply

public IHistogram3D multiply(String name,
                             IHistogram3D hist1,
                             IHistogram3D hist2)
                      throws IllegalArgumentException

Create an IHistogram3D by multiplying two IHistogram3D.

Parameters:

name - The name of the resulting IHistogram3D.

hist1 - The first member of the multiplication.

hist2 - The second member of the multiplication.

Returns:

The product of the two IHistogram3D.

Throws:

IllegalArgumentException - if the two IHistogram3D have incompatible binning.

divide

public IHistogram3D divide(String name,
                           IHistogram3D hist1,
                           IHistogram3D hist2)
                    throws IllegalArgumentException

Create an IHistogram3D by dividing two IHistogram3D.

Parameters:

name - The name of the resulting IHistogram3D.

hist1 - The first member of the division.

hist2 - The second member of the division.

Returns:

The ration of the two IHistogram3D.

Throws:

IllegalArgumentException - if the two IHistogram3D have incompatible binning.

projectionX

public IHistogram1D projectionX(String name,
                                IHistogram2D hist)

Create an IHistogram1D by projecting an IHistogram2D along its x axis. This is equivalent to sliceX(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be projected.

Returns:

The resulting projection.

projectionY

public IHistogram1D projectionY(String name,
                                IHistogram2D hist)

Create an IHistogram1D by projecting an IHistogram2D along its y axis. This is equivalent to sliceY(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be projected.

Returns:

The resulting projection.

sliceX

public IHistogram1D sliceX(String name,
                           IHistogram2D hist,
                           int index)

Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis at a given bin. This is equivalent to sliceX(indexY,indexY).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be sliced.

index - The index of the bin along the y axis where the IHistogram2D has to be sliced.

Returns:

The resulting slice.

sliceY

public IHistogram1D sliceY(String name,
                           IHistogram2D hist,
                           int index)

Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis at a given bin. This is equivalent to sliceY(indexX,indexX).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be sliced.

index - The index of the bin along the x axis where the IHistogram2D has to be sliced.

Returns:

The resulting slice.

sliceX

public IHistogram1D sliceX(String name,
                           IHistogram2D hist,
                           int index1,
                           int index2)

Create an IHistogram1D by slicing an IHistogram2D parallel to the y axis between two bins (inclusive).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be sliced.

index1 - The index of the bin along the y axis that marks the lower edge of the slice.

index2 - The index of the bin along the y axis that marks the upper edge of the slice.

Returns:

The resulting slice.

sliceY

public IHistogram1D sliceY(String name,
                           IHistogram2D hist,
                           int index1,
                           int index2)

Create an IHistogram1D by slicing an IHistogram2D parallel to the x axis between two bins (inclusive).

Parameters:

name - The name of the resulting IHistogram1D.

hist - The IHistogram2D to be sliced.

index1 - The index of the bin along the x axis that marks the lower edge of the slice.

index2 - The index of the bin along the x axis that marks the upper edge of the slice.

Returns:

The resulting slice.

projectionXY

public IHistogram2D projectionXY(String name,
                                 IHistogram3D hist)

Create an IHistogram2D by projecting an IHistogram3D on the x-y plane. This is equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to be projected.

Returns:

The resulting projection.

projectionXZ

public IHistogram2D projectionXZ(String name,
                                 IHistogram3D hist)

Create an IHistogram2D by projecting an IHistogram3D on the x-z plane. This is equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to be projected.

Returns:

The resulting projection.

projectionYZ

public IHistogram2D projectionYZ(String name,
                                 IHistogram3D hist)

Create an IHistogram2D by projecting an IHistogram3D on the y-z plane. This is equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to be projected.

Returns:

The resulting projection.

sliceXY

public IHistogram2D sliceXY(String name,
                            IHistogram3D hist,
                            int index1,
                            int index2)

Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Z axis, between "index1" and "index2" (inclusive). The X axis of the IHistogram2D corresponds to the X axis of this IHistogram3D. The Y axis of the IHistogram2D corresponds to the Y axis of this IHistogram3D.

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to sliced.

index1 - The index of the bin along the z axis that marks the lower edge of the slice.

index2 - The index of the bin along the z axis that marks the upper edge of the slice.

Returns:

The resulting slice.

sliceXZ

public IHistogram2D sliceXZ(String name,
                            IHistogram3D hist,
                            int index1,
                            int index2)

Create an IHistogram2D by slicing an IHistogram3D perpendicular to the Y axis, between "index1" and "index2" (inclusive). The X axis of the IHistogram2D corresponds to the X axis of this IHistogram3D. The Z axis of the IHistogram2D corresponds to the Z axis of this IHistogram3D.

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to sliced.

index1 - The index of the bin along the y axis that marks the lower edge of the slice.

index2 - The index of the bin along the y axis that marks the upper edge of the slice.

Returns:

The resulting slice.

sliceYZ

public IHistogram2D sliceYZ(String name,
                            IHistogram3D hist,
                            int index1,
                            int index2)

Create an IHistogram2D by slicing an IHistogram3D perpendicular to the X axis, between "index1" and "index2" (inclusive). The Y axis of the IHistogram2D corresponds to the Y axis of this IHistogram3D. The Z axis of the IHistogram2D corresponds to the Z axis of this IHistogram3D.

Parameters:

name - The name of the resulting IHistogram2D.

hist - The IHistogram3D to sliced.

index1 - The index of the bin along the x axis that marks the lower edge of the slice.

index2 - The index of the bin along the x axis that marks the upper edge of the slice.

Returns:

The resulting slice.