Package edu.wisc.ssec.mcidasv.data.hydra

Class Statistics

java.lang.Object

edu.wisc.ssec.mcidasv.data.hydra.Statistics

public class Statistics
extends Object

Used to obtain various commonly used statistics for VisAD FlatFields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	Statistics.DescribeParams	Various types of statistics reported by the describe(Object...) "function".
static class	Statistics.Description

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<Character>	CHARS	Characters used to create "sparklines".
(package private) org.apache.commons.math3.stat.descriptive.DescriptiveStatistics[]	descriptiveStats
(package private) int[]	numGoodPoints
(package private) int	numPoints
(package private) org.apache.commons.math3.stat.correlation.PearsonsCorrelation	pCorrelation
(package private) int	rngTupLen
(package private) double[][]	rngVals
(package private) MathType	statType
(package private) double[][]	values_x

Constructor Summary

Constructors

Constructor	Description
Statistics(FlatField fltFld)

Method Summary

Modifier and Type	Method	Description
Data	correlation(FlatField fltFld)
static String	describe(Object... params)	Creates a "description" of any FlatFields in params.
Data	geometricMean()
int[]	getNumGoodPoints()	Get the number of non-missing points in each range component.
double[][]	getRngVals()	Get the original range values.
double[][]	getValues()	Get the range values actually used (missing removed).
static Long[]	histogram(FlatField field, int bins)
Data	kurtosis()
private Data	makeStat(double[] stats)
Data	max()
Data	mean()
Data	median()
Data	min()
int	numPoints()	Get the number of points in the domain of the FlatField.
private static EnumSet<Statistics.DescribeParams>	parseParams(List<String> ps)
Data	percentile(double p)
private double[]	removeMissing(double[] vals)
private double[][]	removeMissing(double[][] vals)
private double[][]	removeMissingAND(double[] vals_x, double[] vals_y)
Data	skewness()
static String	sparkline(FlatField... fields)	Creates a "binned sparkline" of the given FlatFields.
static String	sparkline(FlatField field, Statistics s)
Data	standardDeviation()
Data	variance()

Methods inherited from class java.lang.Object

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

Field Details

CHARS

private static final List<Character> CHARS

Characters used to create "sparklines".

descriptiveStats

org.apache.commons.math3.stat.descriptive.DescriptiveStatistics[] descriptiveStats

values_x

double[][] values_x

rngVals

double[][] rngVals

rngTupLen

int rngTupLen

numPoints

int numPoints

numGoodPoints

int[] numGoodPoints

statType

MathType statType

pCorrelation

org.apache.commons.math3.stat.correlation.PearsonsCorrelation pCorrelation

Constructor Details

Statistics

public Statistics(FlatField fltFld)
           throws VisADException

Throws:

VisADException

Method Details

numPoints

public int numPoints()

Get the number of points in the domain of the FlatField.

Returns:

Number of points.

getNumGoodPoints

public int[] getNumGoodPoints()

Get the number of non-missing points in each range component.

Returns:

Number of non-missing points.

getRngVals

public double[][] getRngVals()

Get the original range values.

Returns:

Original range values.

getValues

public double[][] getValues()

Get the range values actually used (missing removed).

Returns:

Range values used.

removeMissing

private double[] removeMissing(double[] vals)

removeMissing

private double[][] removeMissing(double[][] vals)

mean

public Data mean()
          throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

geometricMean

public Data geometricMean()
                   throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

max

public Data max()
         throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

min

public Data min()
         throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

median

public Data median()
            throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

percentile

public Data percentile(double p)
                throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

variance

public Data variance()
              throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

kurtosis

public Data kurtosis()
              throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

standardDeviation

public Data standardDeviation()
                       throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

skewness

public Data skewness()
              throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

correlation

public Data correlation(FlatField fltFld)
                 throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

makeStat

private Data makeStat(double[] stats)
               throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

removeMissingAND

private double[][] removeMissingAND(double[] vals_x,
 double[] vals_y)

describe

public static String describe(Object... params)
                       throws VisADException,
RemoteException

Creates a "description" of any FlatFields in params.

This is mostly useful from within the Jython Shell.

Some notes about params:

• Understands FlatField and String objects.
• Strings must be found within Statistics.DescribeParams.
• Strings control descriptions returned for all fields in params.
• FlatField and String objects may appear in any order.

Parameters:

params - See description of this method. If null or empty, nothing will happen.

Returns:

String descriptions of any FlatField objects in params, with relevant strings in params controlling what shows up in all descriptions.

Throws:

VisADException - if VisAD had problems.

RemoteException - if VisAD had problems.

sparkline

public static String sparkline(FlatField... fields)
                        throws VisADException,
RemoteException

Creates a "binned sparkline" of the given FlatFields.

Parameters:

fields - FlatField objects to "visualize" with sparklines.

Returns:

String sparkline for each FlatField in fields.

Throws:

VisADException - if VisAD had problems.

RemoteException - if VisAD had problems.

See Also:

• Sparkline Wikipedia Article

histogram

public static Long[] histogram(FlatField field,
 int bins)
                        throws VisADException

Throws:

VisADException

sparkline

public static String sparkline(FlatField field,
 Statistics s)
                        throws VisADException,
RemoteException

Throws:

VisADException

RemoteException

parseParams

private static EnumSet<Statistics.DescribeParams> parseParams(List<String> ps)