hep.aida
Interface IHistogramFactory


public interface IHistogramFactory

Version:
$Id: IHistogramFactory.html,v 1.1 2002/10/08 00:51:18 tonyj Exp $
Author:
Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson, Andreas Pfeiffer, Mark Donszelmann, Guy Barrand
Source Code:
IHistogramFactory.java

Method Summary
 IHistogram1D add(String nameAndLabel, IHistogram1D a, IHistogram1D b)
          Adds two 1D histograms
 IHistogram2D add(String nameAndLabel, IHistogram2D a, IHistogram2D b)
          Adds two 2D histograms
 IHistogram3D add(String nameAndLabel, IHistogram3D a, IHistogram3D b)
          Adds two 3D histograms
 IHistogram1D create1D(String nameAndLabel, int nBins, double lowerEdge, double upperEdge)
           
 IHistogram1D create1D(String name, String label, double[] binEdge, String options)
           
 IHistogram1D create1D(String name, String label, int nBins, double lowerEdge, double upperEdge)
           
 IHistogram1D create1D(String name, String label, int nBins, double lowerEdge, double upperEdge, String options)
           
 IHistogram2D create2D(String nameAndLabel, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
           
 IHistogram2D create2D(String name, String label, double[] binEdgeX, double[] binEdgeY, String options)
           
 IHistogram2D create2D(String name, String label, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY)
           
 IHistogram2D create2D(String name, String label, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, String options)
           
 IHistogram3D create3D(String nameAndLabel, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
           
 IHistogram3D create3D(String name, String label, double[] binEdgeX, double[] binEdgeY, double[] binEdgeZ, String options)
           
 IHistogram3D create3D(String name, String label, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ)
           
 IHistogram3D create3D(String name, String label, int nBinsX, double lowerEdgeX, double upperEdgeX, int nBinsY, double lowerEdgeY, double upperEdgeY, int nBinsZ, double lowerEdgeZ, double upperEdgeZ, String options)
           
 IHistogram1D div(String nameAndLabel, IHistogram1D a, IHistogram1D b)
          Divides two 1D histograms
 IHistogram2D div(String nameAndLabel, IHistogram2D a, IHistogram2D b)
          Divides two 2D histograms
 IHistogram3D div(String nameAndLabel, IHistogram3D a, IHistogram3D b)
          Divides two 3D histograms
 IHistogram1D mul(String nameAndLabel, IHistogram1D a, IHistogram1D b)
          Multiplies two 1D histograms
 IHistogram2D mul(String nameAndLabel, IHistogram2D a, IHistogram2D b)
          Multiplies two 2D histograms
 IHistogram3D mul(String nameAndLabel, IHistogram3D a, IHistogram3D b)
          Multiplies two 3D histograms
 IHistogram1D projectionX(String nameAndLabel, IHistogram2D h)
          Create a projection from a 2D histogram parallel to the X axis.
 IHistogram2D projectionXY(String nameAndLabel, IHistogram3D h)
          Create a projection parallel to the X axis from a 3D histogram.
 IHistogram2D projectionXZ(String nameAndLabel, IHistogram3D h)
          Create a projection parallel to the Z axis from a 3D histogram.
 IHistogram1D projectionY(String nameAndLabel, IHistogram2D h)
          Create a projection from a 2D histogram parallel to the Y axis.
 IHistogram2D projectionYZ(String nameAndLabel, IHistogram3D h)
          Create a projection parallel to the Y axis from a 3D histogram.
 IHistogram1D sliceX(String nameAndLabel, IHistogram2D h, int indexY)
          Slice parallel to the Y axis from a 2D histogram at bin indexY and one bin wide.
 IHistogram1D sliceX(String nameAndLabel, IHistogram2D h, int indexY1, int indexY2)
          Create a slice parallel to the X axis from a 2D histogram, between "indexY1" and "indexY2" (inclusive).
 IHistogram2D sliceXY(String nameAndLabel, IHistogram3D h, int indexZ1, int indexZ2)
          Create a slice perpendicular to the Z axis from a 3D histogram, between "indexZ1" and "indexZ2" (inclusive).
 IHistogram2D sliceXZ(String nameAndLabel, IHistogram3D h, int indexY1, int indexY2)
          Create a slice perpendicular to the Y axis from a 3D histogram, between "indexY1" and "indexY2" (inclusive).
 IHistogram1D sliceY(String nameAndLabel, IHistogram2D h, int indexX)
          Slice parallel to the X axis from a 2D histogram at bin indexX and one bin wide.
 IHistogram1D sliceY(String nameAndLabel, IHistogram2D h, int indexX1, int indexX2)
          Create a slice parallel to the Y axis from a 2D histogram, between "indexX1" and "indexX2" (inclusive).
 IHistogram2D sliceYZ(String nameAndLabel, IHistogram3D h, int indexX1, int indexX2)
          Create a slice perpendicular to the X axis from a 3D histogram, between "indexX1" and "indexX2" (inclusive).
 IHistogram1D sub(String nameAndLabel, IHistogram1D a, IHistogram1D b)
          Subtracts two 1D histograms
 IHistogram2D sub(String nameAndLabel, IHistogram2D a, IHistogram2D b)
          Subtracts two 2D histograms
 IHistogram3D sub(String nameAndLabel, IHistogram3D a, IHistogram3D b)
          Subtracts two 3D histograms
 

Method Detail

create1D

public IHistogram1D create1D(String nameAndLabel,
                             int nBins,
                             double lowerEdge,
                             double upperEdge)

create1D

public IHistogram1D create1D(String name,
                             String label,
                             int nBins,
                             double lowerEdge,
                             double upperEdge)

create1D

public IHistogram1D create1D(String name,
                             String label,
                             int nBins,
                             double lowerEdge,
                             double upperEdge,
                             String options)

create1D

public IHistogram1D create1D(String name,
                             String label,
                             double[] binEdge,
                             String options)

create2D

public IHistogram2D create2D(String nameAndLabel,
                             int nBinsX,
                             double lowerEdgeX,
                             double upperEdgeX,
                             int nBinsY,
                             double lowerEdgeY,
                             double upperEdgeY)

create2D

public IHistogram2D create2D(String name,
                             String label,
                             int nBinsX,
                             double lowerEdgeX,
                             double upperEdgeX,
                             int nBinsY,
                             double lowerEdgeY,
                             double upperEdgeY)

create2D

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

create2D

public IHistogram2D create2D(String name,
                             String label,
                             double[] binEdgeX,
                             double[] binEdgeY,
                             String options)

create3D

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

create3D

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

create3D

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

create3D

public IHistogram3D create3D(String name,
                             String label,
                             double[] binEdgeX,
                             double[] binEdgeY,
                             double[] binEdgeZ,
                             String options)

add

public IHistogram1D add(String nameAndLabel,
                        IHistogram1D a,
                        IHistogram1D b)
                 throws IllegalArgumentException
Adds two 1D histograms
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

sub

public IHistogram1D sub(String nameAndLabel,
                        IHistogram1D a,
                        IHistogram1D b)
                 throws IllegalArgumentException
Subtracts two 1D histograms
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

mul

public IHistogram1D mul(String nameAndLabel,
                        IHistogram1D a,
                        IHistogram1D b)
                 throws IllegalArgumentException
Multiplies two 1D histograms
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

div

public IHistogram1D div(String nameAndLabel,
                        IHistogram1D a,
                        IHistogram1D b)
                 throws IllegalArgumentException
Divides two 1D histograms
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

add

public IHistogram2D add(String nameAndLabel,
                        IHistogram2D a,
                        IHistogram2D b)
                 throws IllegalArgumentException
Adds two 2D histograms
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

sub

public IHistogram2D sub(String nameAndLabel,
                        IHistogram2D a,
                        IHistogram2D b)
                 throws IllegalArgumentException
Subtracts two 2D histograms
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

mul

public IHistogram2D mul(String nameAndLabel,
                        IHistogram2D a,
                        IHistogram2D b)
                 throws IllegalArgumentException
Multiplies two 2D histograms
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

div

public IHistogram2D div(String nameAndLabel,
                        IHistogram2D a,
                        IHistogram2D b)
                 throws IllegalArgumentException
Divides two 2D histograms
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

add

public IHistogram3D add(String nameAndLabel,
                        IHistogram3D a,
                        IHistogram3D b)
                 throws IllegalArgumentException
Adds two 3D histograms
Returns:
a+b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

sub

public IHistogram3D sub(String nameAndLabel,
                        IHistogram3D a,
                        IHistogram3D b)
                 throws IllegalArgumentException
Subtracts two 3D histograms
Returns:
a-b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

mul

public IHistogram3D mul(String nameAndLabel,
                        IHistogram3D a,
                        IHistogram3D b)
                 throws IllegalArgumentException
Multiplies two 3D histograms
Returns:
a*b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

div

public IHistogram3D div(String nameAndLabel,
                        IHistogram3D a,
                        IHistogram3D b)
                 throws IllegalArgumentException
Divides two 3D histograms
Returns:
a/b
Throws:
IllegalArgumentException - if histogram binnings are incompatible

projectionX

public IHistogram1D projectionX(String nameAndLabel,
                                IHistogram2D h)
Create a projection from a 2D histogram parallel to the X axis. Equivalent to sliceX(UNDERFLOW_BIN,OVERFLOW_BIN).

projectionY

public IHistogram1D projectionY(String nameAndLabel,
                                IHistogram2D h)
Create a projection from a 2D histogram parallel to the Y axis. Equivalent to sliceY(UNDERFLOW_BIN,OVERFLOW_BIN).

sliceX

public IHistogram1D sliceX(String nameAndLabel,
                           IHistogram2D h,
                           int indexY)
Slice parallel to the Y axis from a 2D histogram at bin indexY and one bin wide. Equivalent to sliceX(indexY,indexY).

sliceY

public IHistogram1D sliceY(String nameAndLabel,
                           IHistogram2D h,
                           int indexX)
Slice parallel to the X axis from a 2D histogram at bin indexX and one bin wide. Equivalent to sliceY(indexX,indexX).

sliceX

public IHistogram1D sliceX(String nameAndLabel,
                           IHistogram2D h,
                           int indexY1,
                           int indexY2)
Create a slice parallel to the X axis from a 2D histogram, between "indexY1" and "indexY2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

sliceY

public IHistogram1D sliceY(String nameAndLabel,
                           IHistogram2D h,
                           int indexX1,
                           int indexX2)
Create a slice parallel to the Y axis from a 2D histogram, between "indexX1" and "indexX2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

projectionXY

public IHistogram2D projectionXY(String nameAndLabel,
                                 IHistogram3D h)
Create a projection parallel to the X axis from a 3D histogram. Equivalent to sliceXY(UNDERFLOW_BIN,OVERFLOW_BIN).

projectionXZ

public IHistogram2D projectionXZ(String nameAndLabel,
                                 IHistogram3D h)
Create a projection parallel to the Z axis from a 3D histogram. Equivalent to sliceXZ(UNDERFLOW_BIN,OVERFLOW_BIN).

projectionYZ

public IHistogram2D projectionYZ(String nameAndLabel,
                                 IHistogram3D h)
Create a projection parallel to the Y axis from a 3D histogram. Equivalent to sliceYZ(UNDERFLOW_BIN,OVERFLOW_BIN).

sliceXY

public IHistogram2D sliceXY(String nameAndLabel,
                            IHistogram3D h,
                            int indexZ1,
                            int indexZ2)
Create a slice perpendicular to the Z axis from a 3D histogram, between "indexZ1" and "indexZ2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Y axis of this histogram.

sliceXZ

public IHistogram2D sliceXZ(String nameAndLabel,
                            IHistogram3D h,
                            int indexY1,
                            int indexY2)
Create a slice perpendicular to the Y axis from a 3D histogram, between "indexY1" and "indexY2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the X axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.

sliceYZ

public IHistogram2D sliceYZ(String nameAndLabel,
                            IHistogram3D h,
                            int indexX1,
                            int indexX2)
Create a slice perpendicular to the X axis from a 3D histogram, between "indexX1" and "indexX2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created. The X axis of the returned histogram corresponds to the Y axis of this histogram. The Y axis of the returned histogram corresponds to the Z axis of this histogram.


Copyright © 2000, 2001 AIDA Team, All Rights Reserved.