Package hep.aida.ref

Class AbstractHistogram3D

java.lang.Object
hep.aida.ref.Histogram
hep.aida.ref.AbstractHistogram3D
All Implemented Interfaces:
IHistogram, IHistogram3D, Serializable
Direct Known Subclasses:
Histogram3D

abstract class AbstractHistogram3D extends Histogram implements IHistogram3D
Abstract base class extracting and implementing most of the redundancy of the interface.
Version:
1.0, 23/03/2000
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected IAxis
     
    protected IAxis
     
    protected IAxis
     

    Fields inherited from interface hep.aida.IHistogram

    OVERFLOW, serialVersionUID, UNDERFLOW
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Number of all entries in all (both in-range and under/overflow) bins in the histogram.
    int
    Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
    int
    Number of in-range entries in the histogram.
    int
    Number of under and overflow entries in the histogram.
    void
    fill(double x, double y, double z)
    Fill the histogram with weight 1; equivalent to fill(x,y,z,1)..
    protected abstract IHistogram2D
    internalSliceXY(String title, int indexZ1, int indexZ2)
    The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.
    protected abstract IHistogram2D
    internalSliceXZ(String title, int indexY1, int indexY2)
    The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.
    protected abstract IHistogram2D
    internalSliceYZ(String title, int indexX1, int indexX2)
    The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.
    (package private) int
    mapX(int index)
    Package private method to map from the external representation of bin number to our internal representation of bin number
    (package private) int
    mapY(int index)
    Package private method to map from the external representation of bin number to our internal representation of bin number
    (package private) int
    mapZ(int index)
    Package private method to map from the external representation of bin number to our internal representation of bin number
    int[]
    Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
    Create a projection parallel to the XY plane.
    Create a projection parallel to the XZ plane.
    Create a projection parallel to the YZ plane.
    sliceXY(int indexZ)
    Create a slice parallel to the XY plane at bin indexZ and one bin wide.
    sliceXY(int indexZ1, int indexZ2)
    Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2" (inclusive).
    sliceXZ(int indexY)
    Create a slice parallel to the XZ plane at bin indexY and one bin wide.
    sliceXZ(int indexY1, int indexY2)
    Create a slice parallel to the XZ plane, between "indexY1" and "indexY2" (inclusive).
    sliceYZ(int indexX)
    Create a slice parallel to the YZ plane at bin indexX and one bin wide.
    sliceYZ(int indexX1, int indexX2)
    Create a slice parallel to the YZ plane, between "indexX1" and "indexX2" (inclusive).
    double
    Sum of all (both in-range and under/overflow) bin heights in the histogram.
    double
    Sum of in-range bin heights in the histogram.
    double
    Sum of under/overflow bin heights in the histogram.
    Return the X axis.
    Return the Y axis.
    Return the Z axis.

    Methods inherited from class hep.aida.ref.Histogram

    title

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface hep.aida.IHistogram

    equivalentBinEntries, reset, title

    Methods inherited from interface hep.aida.IHistogram3D

    binEntries, binError, binHeight, fill, meanX, meanY, meanZ, rmsX, rmsY, rmsZ
  • Field Details

    • xAxis

      protected IAxis xAxis
    • yAxis

      protected IAxis yAxis
    • zAxis

      protected IAxis zAxis
  • Constructor Details

    • AbstractHistogram3D

      AbstractHistogram3D(String title)
  • Method Details

    • allEntries

      public int allEntries()
      Description copied from interface: IHistogram
      Number of all entries in all (both in-range and under/overflow) bins in the histogram.
      Specified by:
      allEntries in interface IHistogram
    • dimensions

      public int dimensions()
      Description copied from interface: IHistogram
      Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
      Specified by:
      dimensions in interface IHistogram
    • entries

      public int entries()
      Description copied from interface: IHistogram
      Number of in-range entries in the histogram.
      Specified by:
      entries in interface IHistogram
    • extraEntries

      public int extraEntries()
      Description copied from interface: IHistogram
      Number of under and overflow entries in the histogram.
      Specified by:
      extraEntries in interface IHistogram
    • fill

      public void fill(double x, double y, double z)
      Description copied from interface: IHistogram3D
      Fill the histogram with weight 1; equivalent to fill(x,y,z,1)..
      Specified by:
      fill in interface IHistogram3D
    • internalSliceXY

      protected abstract IHistogram2D internalSliceXY(String title, int indexZ1, int indexZ2)
      The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.

      Note 0indexX1 and indexX2 use our INTERNAL bin numbering scheme Note 1The slice is done between indexX1 and indexX2 INCLUSIVE Note 2indexX1 and indexX2 may include the use of under and over flow bins Note 3There is no note 3 (yet)

    • internalSliceXZ

      protected abstract IHistogram2D internalSliceXZ(String title, int indexY1, int indexY2)
      The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.

      Note 0indexY1 and indexY2 use our INTERNAL bin numbering scheme Note 1The slice is done between indexY1 and indexY2 INCLUSIVE Note 2indexY1 and indexY2 may include the use of under and over flow bins Note 3There is no note 3 (yet)

    • internalSliceYZ

      protected abstract IHistogram2D internalSliceYZ(String title, int indexX1, int indexX2)
      The precise meaning of the arguments to the public slice methods is somewhat ambiguous, so we define this internal slice method and clearly specify its arguments.

      Note 0indexX1 and indexX2 use our INTERNAL bin numbering scheme Note 1The slice is done between indexX1 and indexX2 INCLUSIVE Note 2indexX1 and indexX2 may include the use of under and over flow bins Note 3There is no note 3 (yet)

    • mapX

      int mapX(int index)
      Package private method to map from the external representation of bin number to our internal representation of bin number
    • mapY

      int mapY(int index)
      Package private method to map from the external representation of bin number to our internal representation of bin number
    • mapZ

      int mapZ(int index)
      Package private method to map from the external representation of bin number to our internal representation of bin number
    • minMaxBins

      public int[] minMaxBins()
      Description copied from interface: IHistogram3D
      Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
      Specified by:
      minMaxBins in interface IHistogram3D
      Returns:
      {minBinX,minBinY,minBinZ, maxBinX,maxBinY,maxBinZ}.
    • projectionXY

      public IHistogram2D projectionXY()
      Description copied from interface: IHistogram3D
      Create a projection parallel to the XY plane. Equivalent to sliceXY(UNDERFLOW,OVERFLOW).
      Specified by:
      projectionXY in interface IHistogram3D
    • projectionXZ

      public IHistogram2D projectionXZ()
      Description copied from interface: IHistogram3D
      Create a projection parallel to the XZ plane. Equivalent to sliceXZ(UNDERFLOW,OVERFLOW).
      Specified by:
      projectionXZ in interface IHistogram3D
    • projectionYZ

      public IHistogram2D projectionYZ()
      Description copied from interface: IHistogram3D
      Create a projection parallel to the YZ plane. Equivalent to sliceYZ(UNDERFLOW,OVERFLOW).
      Specified by:
      projectionYZ in interface IHistogram3D
    • sliceXY

      public IHistogram2D sliceXY(int indexZ)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the XY plane at bin indexZ and one bin wide. Equivalent to sliceXY(indexZ,indexZ).
      Specified by:
      sliceXY in interface IHistogram3D
    • sliceXY

      public IHistogram2D sliceXY(int indexZ1, int indexZ2)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.
      Specified by:
      sliceXY in interface IHistogram3D
    • sliceXZ

      public IHistogram2D sliceXZ(int indexY)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the XZ plane at bin indexY and one bin wide. Equivalent to sliceXZ(indexY,indexY).
      Specified by:
      sliceXZ in interface IHistogram3D
    • sliceXZ

      public IHistogram2D sliceXZ(int indexY1, int indexY2)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the XZ plane, between "indexY1" and "indexY2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.
      Specified by:
      sliceXZ in interface IHistogram3D
    • sliceYZ

      public IHistogram2D sliceYZ(int indexX)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the YZ plane at bin indexX and one bin wide. Equivalent to sliceYZ(indexX,indexX).
      Specified by:
      sliceYZ in interface IHistogram3D
    • sliceYZ

      public IHistogram2D sliceYZ(int indexX1, int indexX2)
      Description copied from interface: IHistogram3D
      Create a slice parallel to the YZ plane, between "indexX1" and "indexX2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.
      Specified by:
      sliceYZ in interface IHistogram3D
    • sumAllBinHeights

      public double sumAllBinHeights()
      Description copied from interface: IHistogram
      Sum of all (both in-range and under/overflow) bin heights in the histogram.
      Specified by:
      sumAllBinHeights in interface IHistogram
    • sumBinHeights

      public double sumBinHeights()
      Description copied from interface: IHistogram
      Sum of in-range bin heights in the histogram.
      Specified by:
      sumBinHeights in interface IHistogram
    • sumExtraBinHeights

      public double sumExtraBinHeights()
      Description copied from interface: IHistogram
      Sum of under/overflow bin heights in the histogram.
      Specified by:
      sumExtraBinHeights in interface IHistogram
    • xAxis

      public IAxis xAxis()
      Description copied from interface: IHistogram3D
      Return the X axis.
      Specified by:
      xAxis in interface IHistogram3D
    • yAxis

      public IAxis yAxis()
      Description copied from interface: IHistogram3D
      Return the Y axis.
      Specified by:
      yAxis in interface IHistogram3D
    • zAxis

      public IAxis zAxis()
      Description copied from interface: IHistogram3D
      Return the Z axis.
      Specified by:
      zAxis in interface IHistogram3D