GridMath (Unidata IDV API v3.0u2)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ucar.unidata.data.grid
Class GridMath

java.lang.Object
  ucar.unidata.data.grid.GridMath

public class GridMath
extends Object
extends Object

A class to handle grid math. This handles math between grids on different manifolds where possible.

Author:: IDV Development Team

Field Summary
`static String`	`AXIS_X` axis identifier - X
`static String`	`AXIS_Y` axis identifier - Y
`static String`	`FUNC_AVERAGE` function for the applyFunctionOverTime routine
`static String`	`FUNC_DIFFERENCE` function for the timeStepFunc routine
`static String`	`FUNC_MAX` function for the applyFunctionOverTime routine
`static String`	`FUNC_MIN` function for the applyFunctionOverTime routine
`static String`	`FUNC_MODE` function for the applyFunctionOverTime routine
`static String`	`FUNC_PRCNTL` function for the applyFunctionOverTime routine
`static String`	`FUNC_RNG` function for the applyFunctionOverTime routine
`static String`	`FUNC_STDEV` function for the applyFunctionOverTime routine
`static String`	`FUNC_SUM` function for the applyFunctionOverTime routine
`static String`	`FUNC_UPROB` function for the applyFunctionOverTime routine
`static Real`	`NEGATIVE_ONE` negative one
`static int`	`OPT_CYCLIC` cyclic option
`static int`	`OPT_MISSING` missing option
`static int`	`OPT_SYMMETRIC` symmetric option

Constructor Summary
`GridMath()`

Method Summary
`static FieldImpl`	`add(FieldImpl grid1, FieldImpl grid2)` Add two grids together
`static FieldImpl`	`add(FieldImpl grid1, FieldImpl grid2, boolean useWA)` Add two grids together
`static FlatField`	`applyFunctionOverGrids(FlatField[] grids, String function)` Apply the function to the grids.
`static FieldImpl`	`applyFunctionOverLevels(FieldImpl grid, String function)` Apply the function to the time steps of the given grid over the levels.
`static FieldImpl`	`applyFunctionOverMembers(FieldImpl grid, float statThreshold, float exptdLoBound, float exptdUpBound, String function)` Apply the function to the ens members of the given grid.
`static FieldImpl`	`applyFunctionOverMembers(FieldImpl grid, String function)` Apply the function to the ens members of the given grid.
`static FieldImpl`	`applyFunctionOverMembers(FieldImpl grid, String statThreshold, String exptdLoBoundIn, String exptdUpBoundIn, String function)` Apply the function to the ens members of the given grid.
`static FieldImpl`	`applyFunctionOverTime(FieldImpl grid, String function, boolean makeTimes)` Apply the function to the time steps of the given grid.
`static FieldImpl`	`applyFunctionOverTime(FieldImpl grid, String function, int startIdx, int idxStride, boolean makeTimes)` Apply the function to the time steps of the given grid.
`static FieldImpl`	`applyFunctionToAxis(FieldImpl grid, String function, String axis)` Apply the function to the x or y of the given grid at each level.
`static FieldImpl`	`applyFunctionToLevels(FieldImpl grid, String function)` Apply the function to the time steps of the given grid at each level.
`static FieldImpl`	`atan2(FieldImpl grid1, FieldImpl grid2)` Take the arctangent of two grids
`static FieldImpl`	`atan2(FieldImpl grid1, FieldImpl grid2, boolean useWA)` Take the arctangent of two grids
`static FieldImpl`	`averageOverMembers(FieldImpl grid)` Average the grid over member
`static FieldImpl`	`averageOverTime(FieldImpl grid, boolean makeTimes)` Average the grid at each point over time
`static FieldImpl`	`ddx(FieldImpl grid)` Take the partial derivative with respect to X of the given field.
`static FieldImpl`	`ddy(FieldImpl grid)` Take the partial derivative with respect to Y of the given field.
`static FieldImpl`	`differenceFromBaseTime(FieldImpl grid)` This creates a field where D(T) = D(T)-D(0) Any time steps up to the offset time are set to missing
`static FieldImpl`	`divide(FieldImpl grid1, FieldImpl grid2)` Divide two grids
`static FieldImpl`	`divide(FieldImpl grid1, FieldImpl grid2, boolean useWA)` Divide two grids
`static FieldImpl`	`ensembleHighestValues(FieldImpl grid)` ensemble grid max values
`static FieldImpl`	`ensembleLowestValues(FieldImpl grid)` ensemble grid min values
`static FieldImpl`	`ensembleModeValues(FieldImpl grid)` ensemble grid min values
`static FieldImpl`	`ensemblePercentileValues(FieldImpl grid, int percent)` ensemble grid min values
`static FieldImpl`	`ensemblePercentileValues(FieldImpl grid, String percent)` ensemble grid min values
`static FieldImpl`	`ensembleRangeValues(FieldImpl grid)` ensemble grid range values
`static FieldImpl`	`ensembleStandardDeviation(FieldImpl grid)` ensemble Standard Deviation
`static FieldImpl`	`ensembleUProbabilityValues(FieldImpl grid, String logicalOp, float pValue, float exptdLoBound, float exptdUpBound)` ensemble grid univariate probability
`static FieldImpl`	`ensembleUProbabilityValues(FieldImpl grid, String logicalOp, String pValue, String exptdLoBound, String exptdUpBound)` ensemble grid univariate probability
`static float`	`evaluateMode(float[] data)` evaluate mode value
`static float`	`evaluatePercentile(float[] values, int begin, int length, double p)` evaluate percentile value
`static float`	`evaluateUProbability(float[] values, float pValue, int length)` evaluate univariate probability of "variable with n ensemble values" < pValue code from $NAWIPS/gempak/source/diaglib/de/decprb.c used to make this function.
`static FieldImpl`	`maxOverTime(FieldImpl grid, boolean makeTimes)` Take the max value at each grid point
`static FieldImpl`	`minOverTime(FieldImpl grid, boolean makeTimes)` Take the min value at each grid point
`static FieldImpl`	`multiply(FieldImpl grid1, FieldImpl grid2)` Multiply two grids
`static FieldImpl`	`multiply(FieldImpl grid1, FieldImpl grid2, boolean useWA)` Multiply two grids
`static FieldImpl`	`partial(FieldImpl grid, int domainIndex)` Take the partial derivative with respect variable at the domain index.
`static FieldImpl`	`standardDeviationOverTime(FieldImpl grid, boolean makeTimes)` Compute the standard deviation of the grid at each point over time
`static FieldImpl`	`subtract(FieldImpl grid1, FieldImpl grid2)` Subtract two grids
`static FieldImpl`	`subtract(FieldImpl grid1, FieldImpl grid2, boolean useWA)` Subtract two grids
`static FieldImpl`	`sumFromBaseTime(FieldImpl grid)` This creates a field where D(T) = D(0)+D(1)+...+D(T-1)+D(T)
`static FieldImpl`	`sumOverTime(FieldImpl grid, boolean makeTimes)` Sum each grid point
`static FieldImpl`	`timeRunningAverage(FieldImpl grid, int nave, int opt)` Create a running average across the time dimension.
`static FieldImpl`	`timeRunningAverage(FieldImpl grid, int nave, int opt, boolean skipMissing)` Create a running average across the time dimension.
`static FieldImpl`	`timeStepDifference(FieldImpl grid, int offset)` This creates a field where D(T) = D(T)-D(T+offset) Any time steps up to the offset time are set to missing
`static FieldImpl`	`timeStepFunc(FieldImpl grid, int offset, String func)` This creates a field where is either D(T) = D(T)-D(T+offset) or D(T) = D(T)+D(T+offset) depending on the value of the func argument Any time steps up to the offset time are set to missing.
`static FieldImpl`	`timeStepSum(FieldImpl grid, int offset)` This creates a field where D(T) = D(T)+D(T+offset) Any time steps up to the offset time are set to missing
`static FieldImpl`	`timeWeightedRunningAverage(FieldImpl grid, float[] wgts, int opt)` Create a running average across the time dimension.
`static FieldImpl`	`timeWeightedRunningAverage(FieldImpl grid, float[] wgts, int opt, boolean skipMissing)` Create a running average across the time dimension.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail