uk.ac.leeds.ccg.andyt.grids.core
Interface GridStatisticsInterface

All Known Implementing Classes:

AbstractGridStatistics, GridStatistics0, GridStatistics1

public interface GridStatisticsInterface

An interface to be implemented by classes that provide statistics about raster data.

Method Summary

java.math.BigDecimal	getArithmeticMeanBigDecimal(int numberOfDecimalPlaces, boolean handleOutOfMemoryError) For returning the arithmetic mean of all non noDataValues as a BigDecimal
java.math.BigDecimal	getMaxBigDecimal(boolean handleOutOfMemoryError) For returning the maximum of all non noDataValues as a BigDecimal
java.math.BigInteger	getMaxBigInteger(boolean handleOutOfMemoryError) For returning the maximum of all non noDataValues as a BigInteger
double	getMaxDouble(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a double
int	getMaxInt(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a int
long	getMaxLong(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a long
java.math.BigDecimal	getMinBigDecimal(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a BigDecimal
java.math.BigInteger	getMinBigInteger(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a BigInteger
double	getMinDouble(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a double
int	getMinInt(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a int
long	getMinLong(boolean handleOutOfMemoryError) For returning the minimum of all non noDataValues as a long
java.math.BigInteger	getNonNoDataValueCountBigInteger(boolean handleOutOfMemoryError) For returning the number of cells with noDataValues as a BigInteger
int	getNonNoDataValueCountInt(boolean handleOutOfMemoryError) For returning the number of cells with noDataValues as a int
long	getNonNoDataValueCountLong(boolean handleOutOfMemoryError) For returning the number of cells with noDataValues as a long
java.math.BigDecimal	getSumBigDecimal(boolean handleOutOfMemoryError) For returning the sum of all non noDataValues as a BigDecimal
java.math.BigInteger	getSumBigInteger(boolean handleOutOfMemoryError) For returning the sum of all non noDataValues as a BigInteger
double	getSumDouble(boolean handleOutOfMemoryError) For returning the sum of all non noDataValues as a double
int	getSumInt(boolean handleOutOfMemoryError) For returning the sum of all non noDataValues as a int
long	getSumLong(boolean handleOutOfMemoryError) For returning the sum of all non noDataValues as a long

Method Detail

getNonNoDataValueCountBigInteger

java.math.BigInteger getNonNoDataValueCountBigInteger(boolean handleOutOfMemoryError)

For returning the number of cells with noDataValues as a BigInteger

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNonNoDataValueCountLong

long getNonNoDataValueCountLong(boolean handleOutOfMemoryError)

For returning the number of cells with noDataValues as a long

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNonNoDataValueCountInt

int getNonNoDataValueCountInt(boolean handleOutOfMemoryError)

For returning the number of cells with noDataValues as a int

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getSumBigDecimal

java.math.BigDecimal getSumBigDecimal(boolean handleOutOfMemoryError)

For returning the sum of all non noDataValues as a BigDecimal

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getSumBigInteger

java.math.BigInteger getSumBigInteger(boolean handleOutOfMemoryError)

For returning the sum of all non noDataValues as a BigInteger

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getSumDouble

double getSumDouble(boolean handleOutOfMemoryError)

For returning the sum of all non noDataValues as a double

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getSumLong

long getSumLong(boolean handleOutOfMemoryError)

For returning the sum of all non noDataValues as a long

getSumInt

int getSumInt(boolean handleOutOfMemoryError)

For returning the sum of all non noDataValues as a int

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMinBigDecimal

java.math.BigDecimal getMinBigDecimal(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a BigDecimal

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMinBigInteger

java.math.BigInteger getMinBigInteger(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a BigInteger

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMinDouble

double getMinDouble(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a double

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMinLong

long getMinLong(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a long

getMinInt

int getMinInt(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a int

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMaxBigDecimal

java.math.BigDecimal getMaxBigDecimal(boolean handleOutOfMemoryError)

For returning the maximum of all non noDataValues as a BigDecimal

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMaxBigInteger

java.math.BigInteger getMaxBigInteger(boolean handleOutOfMemoryError)

For returning the maximum of all non noDataValues as a BigInteger

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMaxDouble

double getMaxDouble(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a double

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMaxLong

long getMaxLong(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a long

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getMaxInt

int getMaxInt(boolean handleOutOfMemoryError)

For returning the minimum of all non noDataValues as a int

Parameters:

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getArithmeticMeanBigDecimal

java.math.BigDecimal getArithmeticMeanBigDecimal(int numberOfDecimalPlaces,
                                                 boolean handleOutOfMemoryError)

For returning the arithmetic mean of all non noDataValues as a BigDecimal

Parameters:

numberOfDecimalPlaces - The number of decimal places to which the result is precise.

handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.