FloatIHistogram1D
hep.aida.tfloat

Interface FloatIHistogram1D

  • All Superinterfaces:
    FloatIHistogram, Serializable
    All Known Implementing Classes:
    FloatHistogram1D


    public interface FloatIHistogram1Dextends FloatIHistogram
    A Java interface corresponding to the AIDA 1D Histogram.

    Note All methods that accept a bin number as an argument will also accept the constants OVERFLOW or UNDERFLOW as the argument, and as a result give the contents of the resulting OVERFLOW or UNDERFLOW bin.

    See Also:
    AIDA
    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      intbinEntries(int index)
      Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
      floatbinError(int index)
      The error on this bin.
      floatbinHeight(int index)
      Total height of the corresponding bin (ie the sum of the weights in this bin).
      voidfill_2D(float[] data, float[] weights, int rows, int columns, int zero, int rowStride, int columnStride)
      Fill histogram with specified data and weights.
      voidfill_2D(float[] data, int rows, int columns, int zero, int rowStride, int columnStride)
      Fill histogram with specified data and weight 1.
      voidfill(float x)
      Fill histogram with weight 1.
      voidfill(float x, float weight)
      Fill histogram with specified weight.
      floatmean()
      Returns the mean of the whole histogram as calculated on filling-time.
      int[]minMaxBins()
      Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
      floatrms()
      Returns the rms of the whole histogram as calculated on filling-time.
      FloatIAxisxAxis()
      Returns the X Axis.
    • Method Detail

      • binEntries

        int binEntries(int index)
        Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • binError

        float binError(int index)
        The error on this bin.
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • binHeight

        float binHeight(int index)
        Total height of the corresponding bin (ie the sum of the weights in this bin).
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • fill

        void fill(float x)
        Fill histogram with weight 1.
      • fill

        void fill(float x,        float weight)
        Fill histogram with specified weight.
      • fill_2D

        void fill_2D(float[] data,           int rows,           int columns,           int zero,           int rowStride,           int columnStride)
        Fill histogram with specified data and weight 1.
      • fill_2D

        void fill_2D(float[] data,           float[] weights,           int rows,           int columns,           int zero,           int rowStride,           int columnStride)
        Fill histogram with specified data and weights.
      • mean

        float mean()
        Returns the mean of the whole histogram as calculated on filling-time.
      • minMaxBins

        int[] minMaxBins()
        Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
        Returns:
        {minBin,maxBin}.
      • rms

        float rms()
        Returns the rms of the whole histogram as calculated on filling-time.

SCaVis 1.8 © jWork.org