org.opengis.gp
Interface GP_GridAnalysis

All Superinterfaces:
CV_Coverage, GC_GridCoverage, java.rmi.Remote
All Known Implementing Classes:
GP_GridAnalysis_Impl

public interface GP_GridAnalysis
extends GC_GridCoverage

Performs various analysis operations on a grid coverage.

Since:
1.00
Version:
1.00

Method Summary
 PT_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 getStdDev(int sampleDimension)
          Determine the standard deviation from the mean of the grid values for a sample dimension.
 
Methods inherited from interface org.opengis.gc.GC_GridCoverage
getDataBlockAsBoolean, getDataBlockAsByte, getDataBlockAsInteger, getGridGeometry, getGridPacking, getNumOverviews, getOptimalDataBlockSizes, getOverview, getOverviewGridGeometry, getPackedDataBlock, getValueBlockAsDouble, isDataEditable, setDataBlockAsBoolean, setDataBlockAsByte, setDataBlockAsDouble, setDataBlockAsInteger, setPackedDataBlock
 
Methods inherited from interface org.opengis.cv.CV_Coverage
evaluate, evaluateAsBoolean, evaluateAsByte, evaluateAsDouble, evaluateAsInteger, getCoordinateSystem, getDimensionNames, getEnvelope, getMetadataNames, getMetadataValue, getNumSampleDimensions, getNumSources, getSampleDimension, getSource
 

Method Detail

getHistogram

public int[] getHistogram(int sampleDimension,
                          double minimumEntryValue,
                          double maximumEntryValue,
                          int numberEntries)
                   throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getMinValue

public double getMinValue(int sampleDimension)
                   throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getMaxValue

public double getMaxValue(int sampleDimension)
                   throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getMeanValue

public double getMeanValue(int sampleDimension)
                    throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getMedianValue

public double getMedianValue(int sampleDimension)
                      throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getModeValue

public double getModeValue(int sampleDimension)
                    throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getStdDev

public double getStdDev(int sampleDimension)
                 throws java.rmi.RemoteException
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:
java.rmi.RemoteException - if a remote method call failed.

getCorrelation

public PT_Matrix getCorrelation()
                         throws java.rmi.RemoteException
Determine the correlation between sample dimensions in the grid.

Returns:
the correlation between sample dimensions in the grid.
Throws:
java.rmi.RemoteException - if a remote method call failed.