org.opengis.coverage.processing

Interface GridAnalysis

All Superinterfaces:

Coverage, GridCoverage

@UML(identifier="GP_GridAnalysis",
     specification=OGC_01004)
public interface GridAnalysis
extends GridCoverage

Performs various analysis operations on a grid coverage. Such processing functionality includes histogram calculation, grid coverage covariance and other statistical measurements.

WARNING: THIS CLASS WILL CHANGE. Current API is derived from OGC Grid Coverages Implementation specification 1.0. We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry and functions). Current interfaces should be considered as legacy and are included in this distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much compatibility as possible, but no migration plan has been determined yet.

Since:

GeoAPI 1.0

Method Summary

Modifier and Type	Method and Description
Matrix	getCorrelation() Determine the correlation between sample dimensions in the grid.
int[]	getHistogram(int sampleDimension, double minimumEntryValue, double maximumEntryValue, int numberEntries) Determine the histogram of the grid values for a sample dimension.
double	getMaxValue(int sampleDimension) Determine the maximum grid value for a sample dimension.
double	getMeanValue(int sampleDimension) Determine the mean grid value for a sample dimension.
double	getMedianValue(int sampleDimension) Determine the median grid value for a sample dimension.
double	getMinValue(int sampleDimension) Determine the minimum grid value for a sample dimension.
double	getModeValue(int sampleDimension) Determine the mode grid value for a sample dimension.
double	getStandardDeviation(int sampleDimension) Determine the standard deviation from the mean of the grid values for a sample dimension.

Methods inherited from interface org.opengis.coverage.grid.GridCoverage

getDataBlock, getDataBlock, getDataBlock, getDataBlock, getDataBlock, getDataBlock, getGridGeometry, getGridPacking, getNumOverviews, getOptimalDataBlockSizes, getOverview, getOverviewGridGeometry, getPackedDataBlock, isDataEditable, setDataBlock, setDataBlock, setDataBlock, setDataBlock, setDataBlock, setDataBlock, setPackedDataBlock

Methods inherited from interface org.opengis.coverage.Coverage

evaluate, evaluate, evaluate, evaluate, evaluate, evaluate, getCoordinateReferenceSystem, getDimensionNames, getEnvelope, getMetadataNames, getMetadataValue, getNumSampleDimensions, getRenderableImage, getSampleDimension, getSources

Method Detail

getHistogram

@UML(identifier="histogram",
     obligation=MANDATORY,
     specification=OGC_01004)
int[] getHistogram(int sampleDimension,
                                                                                                         double minimumEntryValue,
                                                                                                         double maximumEntryValue,
                                                                                                         int numberEntries)
                                                                                                  throws InvalidSampleDimensionException

Determine the histogram of the grid values for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension to be histogrammed.

minimumEntryValue - Minimum value stored in the first histogram entry.

maximumEntryValue - Maximum value stored in the last histogram entry.

numberEntries - Number of entries in the histogram.

Returns:

The histogram of the grid values for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

See Also:

javax.media.jai.Histogram

getMinValue

@UML(identifier="minValue",
     obligation=MANDATORY,
     specification=OGC_01004)
double getMinValue(int sampleDimension)
                                                                                                 throws InvalidSampleDimensionException

Determine the minimum grid value for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

the minimum grid value for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getMaxValue

@UML(identifier="maxValue",
     obligation=MANDATORY,
     specification=OGC_01004)
double getMaxValue(int sampleDimension)
                                                                                                 throws InvalidSampleDimensionException

Determine the maximum grid value for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

the maximum grid value for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getMeanValue

@UML(identifier="meanValue",
     obligation=MANDATORY,
     specification=OGC_01004)
double getMeanValue(int sampleDimension)
                                                                                                   throws InvalidSampleDimensionException

Determine the mean grid value for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

the mean grid value for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getMedianValue

@UML(identifier="medianValue",
     obligation=MANDATORY,
     specification=OGC_01004)
double getMedianValue(int sampleDimension)
                                                                                                       throws InvalidSampleDimensionException

Determine the median grid value for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

the median grid value for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getModeValue

@UML(identifier="modeValue",
     obligation=MANDATORY,
     specification=OGC_01004)
double getModeValue(int sampleDimension)
                                                                                                   throws InvalidSampleDimensionException

Determine the mode grid value for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

the mode grid value for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getStandardDeviation

@UML(identifier="stdDev",
     obligation=MANDATORY,
     specification=OGC_01004)
double getStandardDeviation(int sampleDimension)
                                                                                                        throws InvalidSampleDimensionException

Determine the standard deviation from the mean of the grid values for a sample dimension.

Parameters:

sampleDimension - Index of sample dimension.

Returns:

he standard deviation from the mean of the grid values for a sample dimension.

Throws:

InvalidSampleDimensionException - if the sample dimension index is out of bounds.

getCorrelation

@UML(identifier="correlation",
     obligation=MANDATORY,
     specification=OGC_01004)
Matrix getCorrelation()

Determine the correlation between sample dimensions in the grid.

Returns:

the correlation between sample dimensions in the grid.