edu.wisc.ssec.mcidasv.data.hydra

Class Statistics

java.lang.Object

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

public class Statistics
extends java.lang.Object

Used to obtain various commonly used statistics for VisAD FlatFields.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<java.lang.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) visad.MathType	statType
(package private) double[][]	values_x

Constructor Summary

Constructors

Constructor and Description
Statistics(visad.FlatField fltFld)

Method Summary

Modifier and Type	Method and Description
visad.Data	correlation(visad.FlatField fltFld)
static java.lang.String	describe(java.lang.Object... params) Creates a "description" of any FlatFields in params.
visad.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 java.lang.Long[]	histogram(visad.FlatField field, int bins)
visad.Data	kurtosis()
private visad.Data	makeStat(double[] stats)
visad.Data	max()
visad.Data	mean()
visad.Data	median()
visad.Data	min()
int	numPoints() Get the number of points in the domain of the FlatField.
private static java.util.EnumSet<Statistics.DescribeParams>	parseParams(java.util.List<java.lang.String> ps)
visad.Data	percentile(double p)
private double[]	removeMissing(double[] vals)
private double[][]	removeMissing(double[][] vals)
private double[][]	removeMissingAND(double[] vals_x, double[] vals_y)
visad.Data	skewness()
static java.lang.String	sparkline(visad.FlatField... fields) Creates a "binned sparkline" of the given FlatFields.
static java.lang.String	sparkline(visad.FlatField field, Statistics s)
visad.Data	standardDeviation()
visad.Data	variance()

Methods inherited from class java.lang.Object

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

Field Detail

CHARS

private static final java.util.List<java.lang.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

visad.MathType statType

pCorrelation

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

Constructor Detail

Statistics

public Statistics(visad.FlatField fltFld)
           throws visad.VisADException

Throws:

visad.VisADException

Method Detail

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 visad.Data mean()
                throws visad.VisADException,
                       java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

geometricMean

public visad.Data geometricMean()
                         throws visad.VisADException,
                                java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

max

public visad.Data max()
               throws visad.VisADException,
                      java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

min

public visad.Data min()
               throws visad.VisADException,
                      java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

median

public visad.Data median()
                  throws visad.VisADException,
                         java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

percentile

public visad.Data percentile(double p)
                      throws visad.VisADException,
                             java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

variance

public visad.Data variance()
                    throws visad.VisADException,
                           java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

kurtosis

public visad.Data kurtosis()
                    throws visad.VisADException,
                           java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

standardDeviation

public visad.Data standardDeviation()
                             throws visad.VisADException,
                                    java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

skewness

public visad.Data skewness()
                    throws visad.VisADException,
                           java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

correlation

public visad.Data correlation(visad.FlatField fltFld)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

makeStat

private visad.Data makeStat(double[] stats)
                     throws visad.VisADException,
                            java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

removeMissingAND

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

describe

public static java.lang.String describe(java.lang.Object... params)
                                 throws visad.VisADException,
                                        java.rmi.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:

visad.VisADException - if VisAD had problems.

java.rmi.RemoteException - if VisAD had problems.

sparkline

public static java.lang.String sparkline(visad.FlatField... fields)
                                  throws visad.VisADException,
                                         java.rmi.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:

visad.VisADException - if VisAD had problems.

java.rmi.RemoteException - if VisAD had problems.

See Also:

Sparkline Wikipedia Article

histogram

public static java.lang.Long[] histogram(visad.FlatField field,
                                         int bins)
                                  throws visad.VisADException

Throws:

visad.VisADException

sparkline

public static java.lang.String sparkline(visad.FlatField field,
                                         Statistics s)
                                  throws visad.VisADException,
                                         java.rmi.RemoteException

Throws:

visad.VisADException

java.rmi.RemoteException

parseParams

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