agi.foundation.terrain

(agi.foundation.terrainreaders-2024r3.jar)

Class GeodasGriddedTerrain

java.lang.Object

agi.foundation.terrain.TerrainProvider

agi.foundation.terrain.RasterTerrainProvider

agi.foundation.terrain.GeodasGriddedTerrain

public class GeodasGriddedTerrain
extends RasterTerrainProvider

A terrain provider for reading the GEODAS gridded data format - GRD98. Undersea terrain is commonly in this format. The format is described at the National Geophysical Data Center.

Constructor Summary

Constructors

Constructor and Description
GeodasGriddedTerrain(StreamFactory streamFactory) Initializes a new instance with the specified stream factory.
GeodasGriddedTerrain(StreamFactory streamFactory, TerrainCacheGroup cacheGroup) Initializes a new instance with the specified stream factory.
GeodasGriddedTerrain(String fileName) Initializes a new instance using the specified filename.
GeodasGriddedTerrain(String fileName, TerrainCacheGroup cacheGroup) Initializes a new instance using the specified G98 filename.

Method Summary

Modifier and Type	Method and Description
TerrainPosts	getPosts(RasterTerrainIndexExtent extent) Gets the posts over a specified area by reading them from the terrain data source.

Methods inherited from class agi.foundation.terrain.RasterTerrainProvider

cartographicExtentToIndexExtent, getCache, getDefaultInterpolator, getDeltaLatitude, getDeltaLatitudeNativeUnits, getDeltaLongitude, getDeltaLongitudeNativeUnits, getEasternPostOffsetNativeUnits, getFirstPartials, getFirstPartials, getHeight, getHeight, getHeightNativeUnits, getHeightNativeUnits, getHeightRelativeToShape, getLatitudePosts, getLongitudePosts, getMinimumSampleSpacing, getNeedsSpecialCoordinateProcessing, getNorthernPostOffsetNativeUnits, getSecondPartials, getSecondPartials, getSouthernPostOffsetNativeUnits, getWesternPostOffsetNativeUnits, indexToLatitude, indexToLongitude, latitudeToIndex, longitudeToIndex, preloadExtent, processCoordinates, setDefaultInterpolator, setDeltaLatitude, setDeltaLatitudeNativeUnits, setDeltaLongitude, setDeltaLongitudeNativeUnits, setEasternPostOffsetNativeUnits, setLatitudePosts, setLongitudePosts, setNeedsSpecialCoordinateProcessing, setNorthernPostOffsetNativeUnits, setSouthernPostOffsetNativeUnits, setWesternPostOffsetNativeUnits, unloadExtent

Methods inherited from class agi.foundation.terrain.TerrainProvider

getBoundingExtent, getBoundingExtentNativeUnits, getGradient, getHeightReference, getHeightRelativeToShape, getHessian, getLocalMinimumSampleSpacing, getNativeToMeters, getNormal, getRadiansToNative, getReferenceSurface, getShape, getShapeFixedFrame, inGlobalBounds, setBoundingExtent, setBoundingExtentNativeUnits, setHeightReference, setNativeToMeters, setRadiansToNative, setReferenceSurface, setShape, setShapeFixedFrame

Methods inherited from class java.lang.Object

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

Constructor Detail

GeodasGriddedTerrain

public GeodasGriddedTerrain(@Nonnull
                            String fileName)

Initializes a new instance using the specified filename.

Parameters:

fileName - The full path and filename of the G98 file.

Throws:

InvalidDataException -

Thrown when any of the following conditions are met:

• The version of the G98 file is not supported.
• The header length is not correct for a G98 file.
• The G98 file specifies an unsupported data type.
• The G98 file specifies an unsupported number type.
• The G98 file specifies an unsupported scale.
• The G98 file specifies an unsupported cell registration.
• The G98 file specifies an unsupported vertical datum.
• The InputStream reading the G98 file unexpectedly ends.

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileName is null.

GeodasGriddedTerrain

public GeodasGriddedTerrain(@Nonnull
                            String fileName,
                            @Nonnull
                            TerrainCacheGroup cacheGroup)

Initializes a new instance using the specified G98 filename.

Parameters:

fileName - The full path and filename of the G98 file.

cacheGroup - The cache group with which to associate this terrain provider.

Throws:

InvalidDataException -

Thrown when any of the following conditions are met:

• The version of the G98 file is not supported.
• The header length is not correct for a G98 file.
• The G98 file specifies an unsupported data type.
• The G98 file specifies an unsupported number type.
• The G98 file specifies an unsupported scale.
• The G98 file specifies an unsupported cell registration.
• The G98 file specifies an unsupported vertical datum.
• The InputStream reading the G98 file unexpectedly ends.

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when fileName or cacheGroup is null.

GeodasGriddedTerrain

public GeodasGriddedTerrain(@Nonnull
                            StreamFactory streamFactory)

Initializes a new instance with the specified stream factory.

Parameters:

streamFactory - The factory to use to create streams to read the terrain data.

Throws:

InvalidDataException -

Thrown when any of the following conditions are met:

• The version of the G98 file is not supported.
• The header length is not correct for a G98 file.
• The G98 file specifies an unsupported data type.
• The G98 file specifies an unsupported number type.
• The G98 file specifies an unsupported scale.
• The G98 file specifies an unsupported cell registration.
• The G98 file specifies an unsupported vertical datum.
• The InputStream reading the G98 file unexpectedly ends.

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when streamFactory is null.

GeodasGriddedTerrain

public GeodasGriddedTerrain(@Nonnull
                            StreamFactory streamFactory,
                            @Nonnull
                            TerrainCacheGroup cacheGroup)

Initializes a new instance with the specified stream factory.

Parameters:

streamFactory - The factory to use to create streams to read the terrain data.

cacheGroup - The cache group with which to associate this terrain provider.

Throws:

InvalidDataException -

Thrown when any of the following conditions are met:

• The version of the G98 file is not supported.
• The header length is not correct for a G98 file.
• The G98 file specifies an unsupported data type.
• The G98 file specifies an unsupported number type.
• The G98 file specifies an unsupported scale.
• The G98 file specifies an unsupported cell registration.
• The G98 file specifies an unsupported vertical datum.
• The InputStream reading the G98 file unexpectedly ends.

IllegalStateException - Thrown when the Earth (get) instance in the CalculationContext is not configured with a mean sea level (MSL).

ArgumentNullException - Thrown when streamFactory or cacheGroup is null.

Method Detail

getPosts

public TerrainPosts getPosts(@Nonnull
                             RasterTerrainIndexExtent extent)

Gets the posts over a specified area by reading them from the terrain data source. This method is not expected to do any caching.

Specified by:

getPosts in class RasterTerrainProvider

Parameters:

extent - The extent of the posts to read.

Returns:

The requested posts.