Package noaa.coastwatch.util

Class BoxSurvey

java.lang.Object

noaa.coastwatch.util.EarthDataSurvey

noaa.coastwatch.util.BoxSurvey

Direct Known Subclasses:

PolygonSurvey

public class BoxSurvey
extends EarthDataSurvey

The BoxSurvey class holds survey information for a rectangle of data values.

Since:

3.1.7

Author:

Peter Hollemans

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BoxSurvey()	Creates a new empty box survey.
	BoxSurvey(DataVariable variable, EarthTransform trans, DataLocation start, DataLocation end)	Creates a new box survey.

Method Summary

Modifier and Type	Method	Description
void	getResults(ReportFormatter formatter)	Gets a results report for the survey.
protected double	getSampleSize()	Gets the sample size (total values sampled divided by the total values in the area) in percent.
protected String	getSurveyType()	Gets the survey type for results reporting.

Methods inherited from class noaa.coastwatch.util.EarthDataSurvey

getExtents, getStatistics, getTransform, getVariableFormat, getVariableName, getVariableUnits, init

Methods inherited from class java.lang.Object

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

Constructor Details

BoxSurvey

protected BoxSurvey()

Creates a new empty box survey.

BoxSurvey

public BoxSurvey(DataVariable variable,
 EarthTransform trans,
 DataLocation start,
 DataLocation end)

Creates a new box survey.

Parameters:

variable - the survey variable.

trans - the survey variable earth transform.

start - the box starting location.

end - the box ending location. The ending location must have coordinates >= the starting location.

Method Details

getSurveyType

protected String getSurveyType()

Gets the survey type for results reporting.

getSampleSize

protected double getSampleSize()

Gets the sample size (total values sampled divided by the total values in the area) in percent.

getResults

public void getResults(ReportFormatter formatter)

Description copied from class: EarthDataSurvey

Gets a results report for the survey.

Overrides:

getResults in class EarthDataSurvey

Parameters:

formatter - the formatter to use for the report.