org.locationtech.geowave.core.index.dimension.bin

Interface IndexBinningStrategy

All Superinterfaces:

Persistable

All Known Implementing Classes:

BasicBinningStrategy, Landsat8TemporalBinningStrategy, TemporalBinningStrategy

public interface IndexBinningStrategy
extends Persistable

This interface enables a dimension to define a methodology for applying bins to a full set of values which can be used by a general purpose space filling curve implementation.

Method Summary

Modifier and Type	Method and Description
double	getBinMax()
double	getBinMin()
BinValue	getBinnedValue(double value) Returns a normalized value (confined to the normalized minimum and maximum of this binning strategy) and a bin from any value within the data set
NumericRange	getDenormalizedRanges(BinRange binnedRange) Given a set of normalized ranges (each of which are confined to the normalized min and max of this binning strategy) with a bin for each of the ranges, this will calculate the original unbinned range.
int	getFixedBinIdSize() Return the fixed size for the bin ID used by this binning strategy
BinRange[]	getNormalizedRanges(NumericData index) Return a set of normalized ranges (each of which are confined to the normalized min and max of this binning strategy) with a bin for each of the ranges.

Methods inherited from interface org.locationtech.geowave.core.index.persist.Persistable

fromBinary, toBinary

Method Detail

getBinMin

double getBinMin()

Returns:

the minimum value to be used by the space filling curve implementation

getBinMax

double getBinMax()

Returns:

the maximum value to be used by the space filling curve implementation

getBinnedValue

BinValue getBinnedValue(double value)

Returns a normalized value (confined to the normalized minimum and maximum of this binning strategy) and a bin from any value within the data set

Parameters:

value - the value that needs to be normalized and binned

Returns:

the normalized value to be used by a space filling curve implementation, and the bin

getNormalizedRanges

BinRange[] getNormalizedRanges(NumericData index)

Return a set of normalized ranges (each of which are confined to the normalized min and max of this binning strategy) with a bin for each of the ranges. If the passed in query range crosses multiple bins, a BinRange for each bin that it intersects will be returned, but if it is wholly contained within a single bin then a single BinRange will be returned

Parameters:

index - the data representing the query range that needs to be normalized and binned

Returns:

the set of all corresponding bins and ranges that the passed in query range intersects

getDenormalizedRanges

NumericRange getDenormalizedRanges(BinRange binnedRange)

Given a set of normalized ranges (each of which are confined to the normalized min and max of this binning strategy) with a bin for each of the ranges, this will calculate the original unbinned range.

Parameters:

binnedRange - the normalized and binned range

Returns:

the original query range represented by the normalized and binned range

getFixedBinIdSize

int getFixedBinIdSize()

Return the fixed size for the bin ID used by this binning strategy

Returns:

the length of the bin ID