agi.foundation.terrain

(agi.foundation.terrainreaders-2025r1.jar)

Class NgaDigitalTerrainElevationDataCell

java.lang.Object

agi.foundation.terrain.TerrainProvider

agi.foundation.terrain.RasterTerrainProvider

agi.foundation.terrain.NgaDigitalTerrainElevationDataCell

public class NgaDigitalTerrainElevationDataCell
extends RasterTerrainProvider

A terrain provider for reading terrain from a single 1 degree x 1 degree cell of a National Geospatial-Intelligence Agency (NGA) Digital Terrain Elevation Data (DTED) file.

Constructor Summary

Constructors

Constructor and Description
NgaDigitalTerrainElevationDataCell(StreamFactory streamFactory) Initializes a new instance with the specified stream factory.
NgaDigitalTerrainElevationDataCell(StreamFactory streamFactory, TerrainCacheGroup cacheGroup) Initializes a new instance with the specified stream factory.
NgaDigitalTerrainElevationDataCell(String fileName) Initializes a new instance using the specified filename.
NgaDigitalTerrainElevationDataCell(String fileName, TerrainCacheGroup cacheGroup) Initializes a new instance using the specified 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

NgaDigitalTerrainElevationDataCell

public NgaDigitalTerrainElevationDataCell(@Nonnull
                                          String fileName)

Initializes a new instance using the specified filename.

Parameters:

fileName - The full path and filename of the DT0, DT1, or DT2 file.

Throws:

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

InvalidDataException - Thrown when the User Header Label at the start of the DTED cell does not have the expected format.

ArgumentNullException - Thrown when fileName is null.

NgaDigitalTerrainElevationDataCell

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

Initializes a new instance using the specified filename.

Parameters:

fileName - The full path and filename of the DT0, DT1, or DT2 file.

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

Throws:

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

InvalidDataException - Thrown when the User Header Label at the start of the DTED cell does not have the expected format.

ArgumentNullException - Thrown when fileName or cacheGroup is null.

NgaDigitalTerrainElevationDataCell

public NgaDigitalTerrainElevationDataCell(@Nonnull
                                          StreamFactory streamFactory)

Initializes a new instance with the specified stream factory.

The streams created by streamFactory must support seeking. This means that the streams must implement ISeekableStream or FileInputStream.

Parameters:

streamFactory - The factory to use to create streams to read the DT0, DT1, or DT2 file.

Throws:

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

InvalidDataException - Thrown when the InputStream created from the streamFactory ends unexpectedly before the required terrain data could be read.

InvalidDataException - Thrown when the User Header Label at the start of the DTED cell does not have the expected format.

ArgumentNullException - Thrown when streamFactory is null.

NgaDigitalTerrainElevationDataCell

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

Initializes a new instance with the specified stream factory.

The streams created by streamFactory must support seeking. This means that the streams must implement ISeekableStream or FileInputStream.

Parameters:

streamFactory - The factory to use to create streams to read the DT0, DT1, or DT2 file.

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

Throws:

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

InvalidDataException - Thrown when the InputStream created from the streamFactory ends unexpectedly before the required terrain data could be read.

InvalidDataException - Thrown when the User Header Label at the start of the DTED cell does not have the expected format.

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.

Throws:

InvalidDataException - Thrown when the stream ends unexpectedly before the required terrain data can be read.