Package noaa.coastwatch.util

Class PolygonSurvey

java.lang.Object

noaa.coastwatch.util.EarthDataSurvey

noaa.coastwatch.util.BoxSurvey

noaa.coastwatch.util.PolygonSurvey

public class PolygonSurvey
extends BoxSurvey

The PolygonSurvey class holds survey information for a polygon of data values.

Since:

3.1.7

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
PolygonSurvey(DataVariable variable, EarthTransform trans, Shape shape)	Creates a new polygon survey.

Method Summary

Modifier and Type	Method	Description
protected double	getSampleSize()	Gets the sample size (total values sampled divided by the total values in the area) in percent.
Shape	getShape()	Gets the shape defining this polygon.
protected String	getSurveyType()	Gets the survey type for results reporting.

Methods inherited from class noaa.coastwatch.util.BoxSurvey

getResults

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

PolygonSurvey

public PolygonSurvey(DataVariable variable,
 EarthTransform trans,
 Shape shape)

Creates a new polygon survey.

Parameters:

variable - the survey variable.

trans - the survey variable earth transform.

shape - the polygon shape.

Method Details

getSurveyType

protected String getSurveyType()

Gets the survey type for results reporting.

Overrides:

getSurveyType in class BoxSurvey

getSampleSize

protected double getSampleSize()

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

Overrides:

getSampleSize in class BoxSurvey

getShape

public Shape getShape()

Gets the shape defining this polygon.