Package noaa.coastwatch.render.feature

Class BinnedGSHHSReader.Bin

java.lang.Object

noaa.coastwatch.render.feature.BinnedGSHHSReader.Bin

Enclosing class:

BinnedGSHHSReader

public class BinnedGSHHSReader.Bin
extends Object

The bin class acts as a container for GSHHS shore segments. Each bin contains a number of segments and a corner location. Bin indexing starts at 0 at (90N, 0E) and proceeds west to east, north to south.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BinnedGSHHSReader.Bin.Segment	The segment class acts as a container for GSHHS shore segment data.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EAST	The east side constant.
static final int	NORTH	The north side constant.
static final int	NORTH_EAST	The north-east corner.
static final int	NORTH_WEST	The north-west corner.
static final int	SOUTH	The south side constant.
static final int	SOUTH_EAST	The south-east corner.
static final int	SOUTH_WEST	The south-west corner.
static final int	WEST	The west side constant.

Constructor Summary

Constructors

Constructor	Description
Bin(int binIndex)	Creates a new bin from the specified index.

Method Summary

Modifier and Type	Method	Description
EarthLocation	getCorner()	Gets the south-west corner earth location.
EarthLocation	getCorner(int index)	Gets the specified corner earth location.
byte	getCornerLevel(int index)	Gets the specified corner level.
LineFeature	getLineFeature(int index)	Gets an earth vector for the specified segment.
byte	getMinimumLevel()	Gets the minimum bin corner level.
List	getPolygonFeatures()	Gets the segments in this bin as a list of closed Earth polygons.
BinnedGSHHSReader.Bin.Segment	getSegment(int index)	Gets the specified segment.
int	getSegments()	Gets the number of segments.

Methods inherited from class java.lang.Object

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

Field Details

SOUTH_WEST

public static final int SOUTH_WEST

The south-west corner.

See Also:

• Constant Field Values

SOUTH_EAST

public static final int SOUTH_EAST

The south-east corner.

See Also:

• Constant Field Values

NORTH_EAST

public static final int NORTH_EAST

The north-east corner.

See Also:

• Constant Field Values

NORTH_WEST

public static final int NORTH_WEST

The north-west corner.

See Also:

• Constant Field Values

SOUTH

public static final int SOUTH

The south side constant.

See Also:

• Constant Field Values

EAST

public static final int EAST

The east side constant.

See Also:

• Constant Field Values

NORTH

public static final int NORTH

The north side constant.

See Also:

• Constant Field Values

WEST

public static final int WEST

The west side constant.

See Also:

• Constant Field Values

Constructor Details

Bin

public Bin(int binIndex)
    throws IOException

Creates a new bin from the specified index. The segments are read into the bin using the current minimum area.

Parameters:

binIndex - the bin index.

Throws:

IOException

See Also:

• BinnedGSHHSReader.getBinIndex(noaa.coastwatch.util.EarthLocation)

Method Details

getSegments

public int getSegments()

Gets the number of segments.

getSegment

public BinnedGSHHSReader.Bin.Segment getSegment(int index)

Gets the specified segment.

getCorner

public EarthLocation getCorner()

Gets the south-west corner earth location.

getCorner

public EarthLocation getCorner(int index)

Gets the specified corner earth location.

getCornerLevel

public byte getCornerLevel(int index)

Gets the specified corner level.

getMinimumLevel

public byte getMinimumLevel()

Gets the minimum bin corner level.

getLineFeature

public LineFeature getLineFeature(int index)

Gets an earth vector for the specified segment.

Parameters:

index - the index of the segment to convert.

Returns:

the new earth vector.

getPolygonFeatures

public List getPolygonFeatures()

Gets the segments in this bin as a list of closed Earth polygons. The convention used is for land polygons to have the counter-clockwise winding direction and water polygons to have clockwise winding. The polygons in the list are specified in rendering order.

Returns:

a list of earth polygon objects based on the segments in this bin.