Package noaa.coastwatch.util

Class VariableStatisticsGenerator

java.lang.Object

noaa.coastwatch.util.VariableStatisticsGenerator

public class VariableStatisticsGenerator
extends Object

The VariableStatisticsGenerator class creates a Statistics object using a data variable and set of constraints.

Since:

3.3.2

Author:

Peter Hollemans

Method Summary

Modifier and Type	Method	Description
Statistics	generate(DataVariable var, DataLocationConstraints constraints)	Generates a statistics object for a variable given location constraints.
static VariableStatisticsGenerator	getInstance()	Gets an instance of this factory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInstance

public static VariableStatisticsGenerator getInstance()

Gets an instance of this factory.

generate

public Statistics generate(DataVariable var,
 DataLocationConstraints constraints)

Generates a statistics object for a variable given location constraints.

Parameters:

var - the variable to get data from.

constraints - the data location bounds and sparseness contraints. If the start and end bounds are not set, the contraint dims field is automatically populated from the variable dimensions.

Returns:

the data statistics computed over the locations in the variable, subject to the location constraints.

Throws:

IllegalArgumentException - if inconsistencies are found in the constraints.