ucar.nc2.internal.grid

Class GridAxis1DHelper

java.lang.Object

ucar.nc2.internal.grid.GridAxis1DHelper

public class GridAxis1DHelper
extends Object

Helper class for GridAxis1D for subsetting and searching.

Constructor Summary

Constructors

Constructor and Description
GridAxis1DHelper(GridAxis1D orgGrid)

Method Summary

Modifier and Type	Method and Description
int	findCoordElement(CoordInterval target, boolean bounded) Given a coordinate interval, find what grid element matches it.
int	findCoordElement(double target, boolean bounded) Given a coordinate position, find what grid element contains it.
GridAxis1D.Builder<?>	makeSubsetByIndex(Range subsetRange)
Optional<GridAxis1D.Builder<?>>	subset(CalendarDateRange dateRange, int stride, Formatter errLog)
Optional<GridAxis1D.Builder<?>>	subset(double minValue, double maxValue, int stride, Formatter errLog)
GridAxis1D.Builder<?>	subsetClosest(CalendarDate date)
GridAxis1D.Builder<?>	subsetClosest(CalendarDate[] date)
GridAxis1D.Builder<?>	subsetClosest(CoordInterval want)
GridAxis1D.Builder<?>	subsetClosest(double want)
GridAxis1D.Builder<?>	subsetLatest()

Methods inherited from class java.lang.Object

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

Constructor Detail

GridAxis1DHelper

public GridAxis1DHelper(GridAxis1D orgGrid)

Method Detail

findCoordElement

public int findCoordElement(CoordInterval target,
                            boolean bounded)

Given a coordinate interval, find what grid element matches it.

Parameters:

target - interval in this coordinate system

bounded - if true, always return a valid index. otherwise can return < 0 or > n-1

Returns:

index of grid point containing it, or < 0 or > n-1 if outside grid area

findCoordElement

public int findCoordElement(double target,
                            boolean bounded)

Given a coordinate position, find what grid element contains it. This means that

 edge[i] <= target < edge[i+1] (if values are ascending)
 edge[i] > target >= edge[i+1] (if values are descending)
 

Parameters:

target - position in this coordinate system

bounded - if true, always return a valid index. otherwise can return < 0 or > n-1

Returns:

index of grid point containing it, or < 0 or > n-1 if outside grid area

subset

public Optional<GridAxis1D.Builder<?>> subset(double minValue,
                                              double maxValue,
                                              int stride,
                                              Formatter errLog)

subsetClosest

public GridAxis1D.Builder<?> subsetClosest(double want)

subsetClosest

public GridAxis1D.Builder<?> subsetClosest(CoordInterval want)

subsetLatest

public GridAxis1D.Builder<?> subsetLatest()

subsetClosest

public GridAxis1D.Builder<?> subsetClosest(CalendarDate date)

subsetClosest

public GridAxis1D.Builder<?> subsetClosest(CalendarDate[] date)

subset

public Optional<GridAxis1D.Builder<?>> subset(CalendarDateRange dateRange,
                                              int stride,
                                              Formatter errLog)

makeSubsetByIndex

public GridAxis1D.Builder<?> makeSubsetByIndex(Range subsetRange)