Package org.geotools.imageio.netcdf.slice

Class NetCDFDimensionIndexes

Object

NetCDFDimensionIndexes

public final class NetCDFDimensionIndexes
extends Object

Dimension indexes and lookup helpers used to resolve NetCDF slice dimensions from domain values.

Use regular-axis math when the coordinate variable is regular, and fall back to a compact array-backed lookup otherwise. The provided lookup implementations support exact-match queries as well as lower/upper bound style searches used by range filters.

This class is used by the slice-query machinery to convert requested time, elevation, and additional-domain values into dimension indices that can be iterated efficiently.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	NetCDFDimensionIndexes.ArrayNumericAxisLookup	Array-backed numeric lookup for irregular numeric axes.
static final record	NetCDFDimensionIndexes.ArrayTimeAxisLookup	Array-backed time lookup for irregular temporal axes.
static interface	NetCDFDimensionIndexes.AxisLookup	Base contract for a dimension axis lookup.
static interface	NetCDFDimensionIndexes.NumericAxisLookup	Lookup interface for numeric axes such as elevation or additional numeric dimensions.
static final record	NetCDFDimensionIndexes.RegularNumericAxisLookup	Regular numeric axis lookup backed by size, start, and step.
static final record	NetCDFDimensionIndexes.RegularTimeAxisLookup	Regular time axis lookup backed by size, start, and step.
static interface	NetCDFDimensionIndexes.TimeAxisLookup	Lookup interface for temporal axes such as the TIME dimension.

Method Summary

Modifier and Type	Method	Description
static int[]	contiguousRange(int startInclusive, int endExclusive)	Returns a contiguous array of indices in the range [startInclusive, endExclusive).
static int	firstIndexAfter(double[] values, double target, boolean inclusive)	Returns the first index after the target on an ordered double array.
static int	firstIndexAfter(long[] values, long target, boolean inclusive)	Returns the first index after the target on an ordered long array.
static NetCDFDimensionIndexes.TimeAxisLookup	forDateAdditional(VariableAdapter.UnidataAdditionalDomain domain)	Creates a temporal lookup from an additional date coordinate variable.
static NetCDFDimensionIndexes.NumericAxisLookup	forNumericAdditional(VariableAdapter.UnidataAdditionalDomain domain)	Creates a numeric lookup from an additional numeric coordinate variable.
static NetCDFDimensionIndexes.TimeAxisLookup	forTime(CoordinateVariable<Date> cv)	Creates a temporal lookup from a time coordinate variable.
static NetCDFDimensionIndexes.NumericAxisLookup	forVertical(VariableAdapter.UnidataVerticalDomain domain)	Creates a numeric lookup from a vertical coordinate variable.
static int	lastIndexBefore(double[] values, double target, boolean inclusive)	Returns the exclusive upper bound index for values before the target on an ordered double array.
static int	lastIndexBefore(long[] values, long target, boolean inclusive)	Returns the upper bound index for values before the target on an ordered long array.

Methods inherited from class Object

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

Method Details

forTime

public static NetCDFDimensionIndexes.TimeAxisLookup forTime(CoordinateVariable<Date> cv)
                                                     throws IOException

Creates a temporal lookup from a time coordinate variable.

Throws:

IOException

forVertical

public static NetCDFDimensionIndexes.NumericAxisLookup forVertical(VariableAdapter.UnidataVerticalDomain domain)
                                                            throws IOException

Creates a numeric lookup from a vertical coordinate variable.

Throws:

IOException

forNumericAdditional

public static NetCDFDimensionIndexes.NumericAxisLookup forNumericAdditional(VariableAdapter.UnidataAdditionalDomain domain)
                                                                     throws IOException

Creates a numeric lookup from an additional numeric coordinate variable.

Throws:

IOException

forDateAdditional

public static NetCDFDimensionIndexes.TimeAxisLookup forDateAdditional(VariableAdapter.UnidataAdditionalDomain domain)
                                                               throws IOException

Creates a temporal lookup from an additional date coordinate variable.

Throws:

IOException

contiguousRange

public static int[] contiguousRange(int startInclusive,
 int endExclusive)

Returns a contiguous array of indices in the range [startInclusive, endExclusive).

firstIndexAfter

public static int firstIndexAfter(long[] values,
 long target,
 boolean inclusive)

Returns the first index after the target on an ordered long array.

lastIndexBefore

public static int lastIndexBefore(long[] values,
 long target,
 boolean inclusive)

Returns the upper bound index for values before the target on an ordered long array.

firstIndexAfter

public static int firstIndexAfter(double[] values,
 double target,
 boolean inclusive)

Returns the first index after the target on an ordered double array.

lastIndexBefore

public static int lastIndexBefore(double[] values,
 double target,
 boolean inclusive)

Returns the exclusive upper bound index for values before the target on an ordered double array.