org.esa.beam.util.math
Class Statistics

java.lang.Object
  org.esa.beam.util.math.Statistics

Deprecated. since BEAM 4.9, replaced by Stx.

@Deprecated
public class Statistics
extends Object

Instances of the Statistics class provide a set of standard statistical variables.

Author:

Norman Fomferra

Constructor Summary

Statistics()
Deprecated.

Method Summary

static Statistics	computeStatistics(Statistics[] statisticsArray, Statistics statistics) Deprecated.
static Statistics	computeStatisticsByte(byte[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsDouble(double[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsDouble(DoubleList values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsFloat(float[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsGeneric(Object values, boolean unsigned, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated. Computes the statistics for the given values.
static Statistics	computeStatisticsInt(int[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsLong(long[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsShort(short[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsUByte(byte[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsUInt(int[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsULong(long[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
static Statistics	computeStatisticsUShort(short[] values, IndexValidator validator, Statistics statistics, com.bc.ceres.core.ProgressMonitor pm) Deprecated.
double	getMax() Deprecated. Gets the maximum value.
double	getMean() Deprecated. Gets the mean value.
double	getMin() Deprecated. Gets the minimum value.
long	getNum() Deprecated. Gets the number of all considered values.
long	getNumTotal() Deprecated. Gets the total number of all values.
double	getRatio() Deprecated. Gets the ratio of the number of all considered values to all values.
double	getSqrSum() Deprecated. Gets the sum of the squares of all considered values.
double	getStdDev() Deprecated. Gets the standard deviation value.
double	getSum() Deprecated. Gets the sum of all considered values.
double	getVar() Deprecated. Gets the variance value.
void	set(long numTotal, long num, double sum, double sqrSum, double min, double max) Deprecated. Sets multiple base properties of this statistics container.
protected void	setMax(double max) Deprecated. Sets the maximum value.
protected void	setMean(double mean) Deprecated. Sets the mean value.
protected void	setMin(double min) Deprecated. Sets the minimum value.
protected void	setNum(long num) Deprecated. Sets the number of all considered values.
protected void	setNumTotal(long numTotal) Deprecated. Sets the total number of all values.
protected void	setSqrSum(double sqrSum) Deprecated. Sets the sum of the squares of all considered values.
protected void	setStdDev(double stdDev) Deprecated. Sets the standard deviation value.
protected void	setSum(double sum) Deprecated. Sets the sum of all considered values.
protected void	setVar(double var) Deprecated. Sets the variance value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Statistics

public Statistics()

Deprecated.

Method Detail

getMin

public double getMin()

Deprecated.

Gets the minimum value.

Returns:

the minimum value

setMin

protected void setMin(double min)

Deprecated.

Sets the minimum value.

Parameters:

min - the minimum value

getMax

public double getMax()

Deprecated.

Gets the maximum value.

Returns:

the maximum value

setMax

protected void setMax(double max)

Deprecated.

Sets the maximum value.

Parameters:

max - the maximum value

getNumTotal

public long getNumTotal()

Deprecated.

Gets the total number of all values.

Returns:

the total number

setNumTotal

protected void setNumTotal(long numTotal)

Deprecated.

Sets the total number of all values.

Parameters:

numTotal - the total number

getNum

public long getNum()

Deprecated.

Gets the number of all considered values.

Returns:

the number

setNum

protected void setNum(long num)

Deprecated.

Sets the number of all considered values.

Parameters:

num - the number

getRatio

public double getRatio()

Deprecated.

Gets the ratio of the number of all considered values to all values.

Returns:

the ratio

getSum

public double getSum()

Deprecated.

Gets the sum of all considered values.

Returns:

the sum

setSum

protected void setSum(double sum)

Deprecated.

Sets the sum of all considered values.

Parameters:

sum - the sum

getSqrSum

public double getSqrSum()

Deprecated.

Gets the sum of the squares of all considered values.

Returns:

the sum of the squares

setSqrSum

protected void setSqrSum(double sqrSum)

Deprecated.

Sets the sum of the squares of all considered values.

Parameters:

sqrSum - the sum of the squares

getMean

public double getMean()

Deprecated.

Gets the mean value.

Returns:

the mean value

setMean

protected void setMean(double mean)

Deprecated.

Sets the mean value.

Parameters:

mean - the mean value

getVar

public double getVar()

Deprecated.

Gets the variance value.

Returns:

the variance value

setVar

protected void setVar(double var)

Deprecated.

Sets the variance value.

Parameters:

var - the variance value

getStdDev

public double getStdDev()

Deprecated.

Gets the standard deviation value.

Returns:

the standard deviation value

setStdDev

protected void setStdDev(double stdDev)

Deprecated.

Sets the standard deviation value.

Parameters:

stdDev - the standard deviation value

set

public void set(long numTotal,
                long num,
                double sum,
                double sqrSum,
                double min,
                double max)

Deprecated.

Sets multiple base properties of this statistics container. The mean, variance and the standard deviation are derived from the number of considered values (num), the sum (sum) and the square sum (sqrSum) of all considered values.

Parameters:

numTotal - the total number of values

num - the number of the considerd values

sum - the sum of the considerd values

sqrSum - the square sum of the considerd values

min - the minimum of the considerd values

max - the maximum of the considerd values

computeStatisticsGeneric

public static Statistics computeStatisticsGeneric(Object values,
                                                  boolean unsigned,
                                                  IndexValidator validator,
                                                  Statistics statistics,
                                                  com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

Computes the statistics for the given values.

Parameters:

values - an array of a primitive type (such as float[]) or an instance of DoubleList. Must not be null.

unsigned - if true, integer type arrays are considered to contain unsigned values, e.g. a byte[] element is considered to be in the range 0...255

validator - a validator used validate a the indexes 0...values.length - 1, must not be null. Use IndexValidator.TRUE instead.

statistics - the instance to be modified and returned. If null, a new instance will be created, set and returned.

Returns:

a new statistics instance if statistics is null, or the modified instance statistics

computeStatisticsByte

public static Statistics computeStatisticsByte(byte[] values,
                                               IndexValidator validator,
                                               Statistics statistics,
                                               com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsUByte

public static Statistics computeStatisticsUByte(byte[] values,
                                                IndexValidator validator,
                                                Statistics statistics,
                                                com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsShort

public static Statistics computeStatisticsShort(short[] values,
                                                IndexValidator validator,
                                                Statistics statistics,
                                                com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsUShort

public static Statistics computeStatisticsUShort(short[] values,
                                                 IndexValidator validator,
                                                 Statistics statistics,
                                                 com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsInt

public static Statistics computeStatisticsInt(int[] values,
                                              IndexValidator validator,
                                              Statistics statistics,
                                              com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsUInt

public static Statistics computeStatisticsUInt(int[] values,
                                               IndexValidator validator,
                                               Statistics statistics,
                                               com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsLong

public static Statistics computeStatisticsLong(long[] values,
                                               IndexValidator validator,
                                               Statistics statistics,
                                               com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsULong

public static Statistics computeStatisticsULong(long[] values,
                                                IndexValidator validator,
                                                Statistics statistics,
                                                com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsFloat

public static Statistics computeStatisticsFloat(float[] values,
                                                IndexValidator validator,
                                                Statistics statistics,
                                                com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsDouble

public static Statistics computeStatisticsDouble(double[] values,
                                                 IndexValidator validator,
                                                 Statistics statistics,
                                                 com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatisticsDouble

public static Statistics computeStatisticsDouble(DoubleList values,
                                                 IndexValidator validator,
                                                 Statistics statistics,
                                                 com.bc.ceres.core.ProgressMonitor pm)

Deprecated.

See Also:

computeStatisticsGeneric(java.lang.Object, boolean, org.esa.beam.util.math.IndexValidator, org.esa.beam.util.math.Statistics, com.bc.ceres.core.ProgressMonitor)

computeStatistics

public static Statistics computeStatistics(Statistics[] statisticsArray,
                                           Statistics statistics)

Deprecated.