Cloud1D
hep.aida.ref.histogram

Class Cloud1D

    • Constructor Detail

      • Cloud1D

        public Cloud1D()
        Create a new Cloud1D
    • Method Detail

      • fill

        public void fill(double value)
        Fill the Cloud with a new value with unit weight
        Specified by:
        fill in interface ICloud1D
        Parameters:
        value - The value to add to the Cloud.
      • fill

        public void fill(double value,        double weight)
        Fill the Cloud with a new value with given weight
        Specified by:
        fill in interface ICloud1D
        Parameters:
        value - The value to add to the Cloud.
        weight - The value's weight.
      • lowerEdge

        public double lowerEdge()
        Get the Cloud's lower edge.
        Specified by:
        lowerEdge in interface ICloud1D
        Returns:
        The Cloud's lower edge.
      • upperEdge

        public double upperEdge()
        Get the Cloud's upper edge.
        Specified by:
        upperEdge in interface ICloud1D
        Returns:
        The Cloud's upper edge.
      • setUpperEdge

        public void setUpperEdge(double upperEdge)
        Set the Cloud's upper edge
        Parameters:
        upperEdge - The Cloud's upper edge.
      • setLowerEdge

        public void setLowerEdge(double lowerEdge)
        Set the Cloud's lower edge
        Parameters:
        lowerEdge - The Cloud's lower edge.
      • value

        public double value(int index)
        Get a given value from the Cloud.
        Specified by:
        value in interface ICloud1D
        Parameters:
        index - The value's index.
        Returns:
        The Cloud's corresponding value.
        Throws:
        RuntimeException - if the Cloud has been converted
      • weight

        public double weight(int index)
        Get a given weight from the Cloud.
        Specified by:
        weight in interface ICloud1D
        Parameters:
        index - The weight's index.
        Returns:
        The Cloud's corresponding weight.
        Throws:
        RuntimeException - if the Cloud has been converted
      • mean

        public double mean()
        Get the Cloud's mean.
        Specified by:
        mean in interface ICloud1D
        Returns:
        The Cloud's mean.
      • rms

        public double rms()
        Get the Cloud's rms.
        Specified by:
        rms in interface ICloud1D
        Returns:
        The Cloud's rms.
      • convert

        public void convert(int nBins,           double lowerEdge,           double upperEdge)
        Convert the ICloud to an IHistogram.
        Specified by:
        convert in interface ICloud1D
        Parameters:
        nBins - The number of bins.
        lowerEdge - The lower edge.
        upperEdge - The upper edge.
      • convert

        public void convert(double[] binEdges)
        Convert the ICloud to an IHistogram by specifying the bin edges.
        Specified by:
        convert in interface ICloud1D
        Parameters:
        binEdges - The bins edges.
      • isConverted

        public boolean isConverted()
        Has the Cloud been converted to a Histogram?
        Specified by:
        isConverted in interface ICloud
        Specified by:
        isConverted in class Cloud
        Returns:
        true<\code> if the Cloud has been converted to a Histogram.
      • setHistogram

        public void setHistogram(IHistogram1D hist)
        Set the Histogram representation of the Cloud.
        Parameters:
        hist - The Histogram representing the Cloud.
      • fillHistogram

        public void fillHistogram(IHistogram1D hist1d)
        Description copied from interface: ICloud1D
        Project the ICloud1D on an IHistogram1D.
        Specified by:
        fillHistogram in interface ICloud1D
        Parameters:
        hist1d - The IHistogram1D to be filled.
      • reset

        public void reset()
        Description copied from class: Cloud
        Reset the histogram; as if just created.
        Specified by:
        reset in interface IBaseHistogram
        Overrides:
        reset in class Cloud
      • sumOfWeights

        public double sumOfWeights()
        Get the sum of weights of of all the entries
        Specified by:
        sumOfWeights in interface ICloud
        Specified by:
        sumOfWeights in class Cloud
        Returns:
        The sum of the weights of all the entries.
      • lowerEdgeWithMargin

        public double lowerEdgeWithMargin()
      • upperEdgeWithMargin

        public double upperEdgeWithMargin()
      • setConversionParameters

        public void setConversionParameters(int bins,                           double lowerEdge,                           double upperEdge)
        Set the parameters for the ICloud conversion to an IHistogram.
        Specified by:
        setConversionParameters in interface ICloud1D
        Parameters:
        bins - The number of bins of the conversion IHistogram.
        lowerEdge - The lower edge of the conversion IHistogram.
        upperEdge - The upper edge of the conversion IHistogram.
      • conversionBins

        public int conversionBins()
      • conversionLowerEdge

        public double conversionLowerEdge()
      • conversionUpperEdge

        public double conversionUpperEdge()

SCaVis 1.8 © jWork.org