Cloud3D
hep.aida.ref.histogram

Class Cloud3D

    • Constructor Detail

      • Cloud3D

        public Cloud3D()
        Create a new Cloud3D
    • Method Detail

      • fill

        public void fill(double xValue,        double yValue,        double zValue)
        Fill the Cloud with new values with unit weight
        Specified by:
        fill in interface ICloud3D
        Parameters:
        xValue - The x value to add to the Cloud.
        yValue - The y value to add to the Cloud.
        zValue - The z value to add to the Cloud.
      • fill

        public void fill(double xValue,        double yValue,        double zValue,        double weight)
        Fill the Cloud with new values with given weight
        Specified by:
        fill in interface ICloud3D
        Parameters:
        xValue - The x value to add to the Cloud.
        yValue - The y value to add to the Cloud.
        zValue - The z value to add to the Cloud.
        weight - The values weight.
      • lowerEdgeX

        public double lowerEdgeX()
        Get the Cloud's x lower edge.
        Specified by:
        lowerEdgeX in interface ICloud3D
        Returns:
        The Cloud's x lower edge.
      • lowerEdgeY

        public double lowerEdgeY()
        Get the Cloud's y lower edge.
        Specified by:
        lowerEdgeY in interface ICloud3D
        Returns:
        The Cloud's y lower edge.
      • lowerEdgeZ

        public double lowerEdgeZ()
        Get the Cloud's z lower edge.
        Specified by:
        lowerEdgeZ in interface ICloud3D
        Returns:
        The Cloud's z lower edge.
      • upperEdgeX

        public double upperEdgeX()
        Get the Cloud's x upper edge.
        Specified by:
        upperEdgeX in interface ICloud3D
        Returns:
        The Cloud's x upper edge.
      • upperEdgeY

        public double upperEdgeY()
        Get the Cloud's y upper edge.
        Specified by:
        upperEdgeY in interface ICloud3D
        Returns:
        The Cloud's y upper edge.
      • upperEdgeZ

        public double upperEdgeZ()
        Get the Cloud's z upper edge.
        Specified by:
        upperEdgeZ in interface ICloud3D
        Returns:
        The Cloud's z upper edge.
      • setLowerEdgeX

        public void setLowerEdgeX(double lowerEdgeX)
        Set the Cloud's x lower edge
        Parameters:
        lowerEdgeX - The Cloud's x lower edge.
      • setLowerEdgeY

        public void setLowerEdgeY(double lowerEdgeY)
        Set the Cloud's y lower edge
        Parameters:
        lowerEdgeY - The Cloud's y lower edge.
      • setLowerEdgeZ

        public void setLowerEdgeZ(double lowerEdgeZ)
        Set the Cloud's z lower edge
        Parameters:
        lowerEdgeZ - The Cloud's z lower edge.
      • setUpperEdgeX

        public void setUpperEdgeX(double upperEdgeX)
        Set the Cloud's x upper edge
        Parameters:
        upperEdgeX - The Cloud's x upper edge.
      • setUpperEdgeY

        public void setUpperEdgeY(double upperEdgeY)
        Set the Cloud's y upper edge
        Parameters:
        upperEdgeY - The Cloud's y upper edge.
      • setUpperEdgeZ

        public void setUpperEdgeZ(double upperEdgeZ)
        Set the Cloud's z upper edge
        Parameters:
        upperEdgeZ - The Cloud's z upper edge.
      • valueX

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

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

        public double valueZ(int index)
        Get a given z value from the Cloud.
        Specified by:
        valueZ in interface ICloud3D
        Parameters:
        index - The z value's index.
        Returns:
        The Cloud's corresponding z 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 ICloud3D
        Parameters:
        index - The weight's index.
        Returns:
        The Cloud's corresponding weight.
        Throws:
        RuntimeException - if the Cloud has been converted
      • meanX

        public double meanX()
        Get the Cloud's x mean.
        Specified by:
        meanX in interface ICloud3D
        Returns:
        The Cloud's x mean.
      • meanY

        public double meanY()
        Get the Cloud's y mean.
        Specified by:
        meanY in interface ICloud3D
        Returns:
        The Cloud's y mean.
      • meanZ

        public double meanZ()
        Get the Cloud's z mean.
        Specified by:
        meanZ in interface ICloud3D
        Returns:
        The Cloud's z mean.
      • rmsX

        public double rmsX()
        Get the Cloud's x rms.
        Specified by:
        rmsX in interface ICloud3D
        Returns:
        The Cloud's x rms.
      • rmsY

        public double rmsY()
        Get the Cloud's y rms.
        Specified by:
        rmsY in interface ICloud3D
        Returns:
        The Cloud's y rms.
      • rmsZ

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

        public void convert(int nBinsX,           double lowerEdgeX,           double upperEdgeX,           int nBinsY,           double lowerEdgeY,           double upperEdgeY,           int nBinsZ,           double lowerEdgeZ,           double upperEdgeZ)
        Convert the Cloud to a Histogram.
        Specified by:
        convert in interface ICloud3D
        Parameters:
        nBinsX - The Histogram's x number of bins.
        lowerEdgeX - The Histogram's x lower edge.
        upperEdgeX - The Histogram's x upper edge.
        nBinsY - The Histogram's y number of bins.
        lowerEdgeY - The Histogram's y lower edge.
        upperEdgeY - The Histogram's y upper edge.
        nBinsZ - The Histogram's z number of bins.
        lowerEdgeZ - The Histogram's z lower edge.
        upperEdgeZ - The Histogram's z upper edge.
      • convert

        public void convert(double[] binEdgesX,           double[] binEdgesY,           double[] binEdgesZ)
        Description copied from interface: ICloud3D
        Convert internally the ICloud3D to an IHistogram3D with given bin edges.
        Specified by:
        convert in interface ICloud3D
        Parameters:
        binEdgesX - The bins edges of the x axis.
        binEdgesY - The bins edges of the y axis.
        binEdgesZ - The bins edges of the z axis.
      • 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(IHistogram3D hist)
        Set the Histogram representation of the Cloud.
        Parameters:
        hist - The Histogram representing the Cloud.
      • fillHistogram

        public void fillHistogram(IHistogram3D hist3d)
        Description copied from interface: ICloud3D
        Project the ICloud3D on an IHistogram3D.
        Specified by:
        fillHistogram in interface ICloud3D
        Parameters:
        hist3d - The IHistogram3D 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
      • lowerEdgeXWithMargin

        public double lowerEdgeXWithMargin()
      • upperEdgeXWithMargin

        public double upperEdgeXWithMargin()
      • lowerEdgeYWithMargin

        public double lowerEdgeYWithMargin()
      • upperEdgeYWithMargin

        public double upperEdgeYWithMargin()
      • lowerEdgeZWithMargin

        public double lowerEdgeZWithMargin()
      • upperEdgeZWithMargin

        public double upperEdgeZWithMargin()
      • 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.
      • setConversionParameters

        public void setConversionParameters(int binsX,                           double lowerEdgeX,                           double upperEdgeX,                           int binsY,                           double lowerEdgeY,                           double upperEdgeY,                           int binsZ,                           double lowerEdgeZ,                           double upperEdgeZ)
        Set the parameters for the ICloud conversion to an IHistogram.
        Specified by:
        setConversionParameters in interface ICloud3D
        Parameters:
        binsX - The X axis number of bins of the conversion IHistogram.
        lowerEdgeX - The X axis lower edge of the conversion IHistogram.
        upperEdgeX - The X axis upper edge of the conversion IHistogram.
        binsY - The Y axis number of bins of the conversion IHistogram.
        lowerEdgeY - The Y axis lower edge of the conversion IHistogram.
        upperEdgeY - The Y axis upper edge of the conversion IHistogram.
        binsZ - The Z axis number of bins of the conversion IHistogram.
        lowerEdgeZ - The Z axis lower edge of the conversion IHistogram.
        upperEdgeZ - The Z axis upper edge of the conversion IHistogram.
      • conversionBinsX

        public int conversionBinsX()
      • conversionLowerEdgeX

        public double conversionLowerEdgeX()
      • conversionUpperEdgeX

        public double conversionUpperEdgeX()
      • conversionBinsY

        public int conversionBinsY()
      • conversionLowerEdgeY

        public double conversionLowerEdgeY()
      • conversionUpperEdgeY

        public double conversionUpperEdgeY()
      • conversionBinsZ

        public int conversionBinsZ()
      • conversionLowerEdgeZ

        public double conversionLowerEdgeZ()
      • conversionUpperEdgeZ

        public double conversionUpperEdgeZ()

SCaVis 2.1 © jWork.ORG