gov.usgs.earthquake.nshmp.data

Interface IntervalVolume

public interface IntervalVolume

A 3-dimensional volume of immutable, double-valued data that is arranged according to increasing and uniformly spaced double-valued keys. Data volumes are used to represent binned data, and so while row, column, and level keys are bin centers, indexing is managed internally using bin edges. This simplifies issues related to rounding/precision errors that occur when indexing according to explicit double values.

To create an instance of an IntervalVolume, use a IntervalVolume.Builder.

Internally, an IntervalVolume is backed by a double[][][] where 'row' maps to the 1st dimension, 'column' the 2nd dimension, and 'level' the 3rd.

Note that interval volumes are not intended for use with very high precision data and keys are currently limited to a precision of 4 decimal places. This may change in the future.

Author:

Peter Powers

See Also:

IntervalData, IntervalArray, IntervalTable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IntervalVolume.Builder A builder of immutable IntervalVolumes.
static interface	IntervalVolume.Loader A supplier of values with which to fill a IntervalVolume.

Method Summary

Modifier and Type	Method and Description
IntervalTable	collapse() Return a new IntervalTable created by summing the levels of this volume.
XySequence	column(double rowValue, double columnValue) Return an immutable view of the values that map to the supplied row and column values.
XySequence	column(int rowIndex, int columnIndex) Return an immutable view of the values that map to the supplied row and column values.
double	columnMax() Return the upper edge of the uppermost column bin.
double	columnMin() Return the lower edge of the lowermost column bin.
List<Double>	columns() Return an immutable list view of the column keys (bin centers).
double	columnΔ() Return the column bin discretization.
double	get(double rowValue, double columnValue, double levelValue) Return the value of the bin that maps to the supplied row, column, and level values.
double	get(int rowIndex, int columnIndex, int levelIndex) Return the value of the bin that maps to the supplied row, column, and level indices.
double	levelMax() Return the upper edge of the uppermost level bin.
double	levelMin() Return the lower edge of the lowermost level bin.
List<Double>	levels() Return an immutable list view of the level keys (bin centers).
double	levelΔ() Return the level bin discretization.
int[]	maxIndex() Return the indices of the bin with largest value in the form [rowIndex, columnIndex, levelIndex].
int[]	minIndex() Return the indices of the bin with smallest value in the form [rowIndex, columnIndex, levelIndex].
double	rowMax() Return the upper edge of the uppermost row bin.
double	rowMin() Return the lower edge of the lowermost row bin.
List<Double>	rows() Return an immutable list view of the row keys (bin centers).
double	rowΔ() Return the row bin discretization.

Method Detail

get

double get(double rowValue,
           double columnValue,
           double levelValue)

Return the value of the bin that maps to the supplied row, column, and level values. Do not confuse this method with get(int, int, int) by row index.

Parameters:

rowValue - of bin to retrieve

columnValue - of bin to retrieve

levelValue - of bin to retrieve

Throws:

IndexOutOfBoundsException - if any value is out of range

get

double get(int rowIndex,
           int columnIndex,
           int levelIndex)

Return the value of the bin that maps to the supplied row, column, and level indices. Do not confuse this method with get(double, double, double) by row value.

Parameters:

rowIndex - of bin to retrieve

columnIndex - of bin to retrieve

levelIndex - of bin to retrieve

Throws:

IndexOutOfBoundsException - if any index is out of range

column

XySequence column(double rowValue,
                  double columnValue)

Return an immutable view of the values that map to the supplied row and column values. Do not confuse with column(int, int) retrieval by index.

Parameters:

rowValue - of bin to retrieve

columnValue - of bin to retrieve

column

XySequence column(int rowIndex,
                  int columnIndex)

Return an immutable view of the values that map to the supplied row and column values. Do not confuse with column(double, double) retrieval by index.

Parameters:

rowIndex - of bin to retrieve

columnIndex - of bin to retrieve

rowMin

double rowMin()

Return the lower edge of the lowermost row bin.

rowMax

double rowMax()

Return the upper edge of the uppermost row bin.

rowΔ

double rowΔ()

Return the row bin discretization.

rows

List<Double> rows()

Return an immutable list view of the row keys (bin centers).

columnMin

double columnMin()

Return the lower edge of the lowermost column bin.

columnMax

double columnMax()

Return the upper edge of the uppermost column bin.

columnΔ

double columnΔ()

Return the column bin discretization.

columns

List<Double> columns()

Return an immutable list view of the column keys (bin centers).

levelMin

double levelMin()

Return the lower edge of the lowermost level bin.

levelMax

double levelMax()

Return the upper edge of the uppermost level bin.

levelΔ

double levelΔ()

Return the level bin discretization.

levels

List<Double> levels()

Return an immutable list view of the level keys (bin centers).

collapse

IntervalTable collapse()

Return a new IntervalTable created by summing the levels of this volume.

minIndex

int[] minIndex()

Return the indices of the bin with smallest value in the form [rowIndex, columnIndex, levelIndex].

maxIndex

int[] maxIndex()

Return the indices of the bin with largest value in the form [rowIndex, columnIndex, levelIndex].