gov.nasa.worldwind.terrain
Class BasicElevationModel
java.lang.Object
 gov.nasa.worldwind.avlist.AVListImpl
gov.nasa.worldwind.WWObjectImpl
gov.nasa.worldwind.terrain.AbstractElevationModel
gov.nasa.worldwind.terrain.BasicElevationModel
- All Implemented Interfaces:
- AVList, ElevationModel, NamedObject, Restorable, BulkRetrievable, WWObject, PropertyChangeListener, EventListener
- Direct Known Subclasses:
- WMSBasicElevationModel
public class BasicElevationModel - extends AbstractElevationModel
- implements BulkRetrievable
|
Method Summary |
protected void |
addTileToCache(BasicElevationModel.ElevationTile tile,
BufferWrapper elevations)
|
protected boolean |
areElevationsInMemory(TileKey key)
|
protected void |
checkResources()
|
int |
computeLevelForResolution(Sector sector,
double resolution)
|
boolean |
contains(Angle latitude,
Angle longitude)
Indicates whether a specified location is within the elevation model's domain. |
protected static ByteBuffer |
convertImageToElevations(ByteBuffer buffer,
String contentType)
|
int |
countTilesInSector(Sector sector,
int levelNumber)
|
protected Document |
createConfigurationDocument(AVList params)
|
protected MemoryCache |
createMemoryCache(String cacheName)
|
protected BasicElevationModel.ElevationTile |
createTile(TileKey key)
|
protected void |
doGetRestorableState(RestorableSupport rs,
RestorableSupport.StateObject context)
|
protected void |
doGetRestorableStateForAVPair(String key,
Object value,
RestorableSupport rs,
RestorableSupport.StateObject context)
|
protected void |
doRestoreState(RestorableSupport rs,
RestorableSupport.StateObject context)
|
protected void |
doRestoreStateForObject(RestorableSupport rs,
RestorableSupport.StateObject so)
|
protected void |
downloadElevations(Tile tile)
|
protected void |
downloadElevations(Tile tile,
BasicElevationModel.DownloadPostProcessor postProcessor)
|
protected void |
doWriteConfigurationParams(FileStore fileStore,
String fileName,
AVList params)
|
ByteBuffer |
generateExtremeElevations(int levelNumber)
|
double |
getBestResolution(Sector sector)
Indicates the best resolution attainable for a specified sector. |
protected AVList |
getConfigurationParams(AVList params)
|
double |
getDetailHint(Sector sector)
Returns the detail hint associated with the specified sector. |
String |
getElevationDataByteOrder()
|
String |
getElevationDataPixelType()
|
protected BasicElevationModel.Elevations |
getElevations(Sector sector,
LevelSet levelSet,
int targetLevelNumber)
|
double |
getElevations(Sector sector,
List<? extends LatLon> latlons,
double targetResolution,
double[] buffer)
Returns the elevations of a collection of locations. |
long |
getEstimatedMissingDataSize(Sector sector,
double resolution)
Get the estimated size in byte of the missing elevation data for the given Sector and resolution. |
double[] |
getExtremeElevations(Angle latitude,
Angle longitude)
Returns the minimum and maximum elevations at a specified location. |
double[] |
getExtremeElevations(Sector sector)
Returns the minimum and maximum elevations within a specified sector of the elevation model. |
protected BufferWrapper |
getExtremes()
|
protected int |
getExtremesLevel()
|
LevelSet |
getLevels()
|
protected Map<TileKey,BasicElevationModel.ElevationTile> |
getLevelZeroTiles()
|
double |
getMaxElevation()
Returns the maximum elevation contained in the elevevation model. |
protected MemoryCache |
getMemoryCache()
|
double |
getMinElevation()
Returns the minimum elevation contained in the elevevation model. |
protected static AVList |
getParamsFromDocument(Element domElement,
AVList params)
|
String |
getRestorableState()
Returns an XML document string describing the object’s state. |
protected Level |
getTargetLevel(Sector sector,
double targetSize)
|
protected BasicElevationModel.ElevationTile |
getTileFromMemory(TileKey tileKey)
|
Tile[][] |
getTilesInSector(Sector sector,
int levelNumber)
|
double |
getUnmappedElevation(Angle latitude,
Angle longitude)
Returns the elevation at a specified location, but without mapping missing data to the elevation model's missing
data replacement value. |
protected void |
initializeResources(AVList params)
|
protected void |
initPropertiesFromCapabilities(Capabilities caps,
AVList params)
|
protected void |
initPropertiesFromService(AVList params)
|
int |
intersects(Sector sector)
Indicates whether the elevation model corresponds to a specified sector. |
protected boolean |
loadElevations(BasicElevationModel.ElevationTile tile,
URL url)
|
void |
loadExtremeElevations(String extremesFileName)
|
protected double |
lookupElevation(double latRadians,
double lonRadians,
BasicElevationModel.ElevationTile tile)
|
BulkRetrievalThread |
makeLocal(Sector sector,
double resolution)
Start a new BulkRetrievalThread that will try to download all elevation tiles for a given Sector
and resolution. |
protected boolean |
needsConfigurationFile(FileStore fileStore,
String fileName,
AVList params,
boolean removeIfExpired)
|
protected BufferWrapper |
readElevations(URL url)
|
protected void |
requestTile(TileKey key)
|
protected static AVList |
restorableStateToParams(String stateInXml)
|
void |
restoreState(String stateInXml)
Restores the object’s state to what is described in the specified XML document string. |
protected static void |
restoreStateForParams(RestorableSupport rs,
RestorableSupport.StateObject context,
AVList params)
|
void |
setByteOrder(String byteOrder)
|
void |
setDetailHint(double hint)
|
void |
setExpiryTime(long expiryTime)
Specifies the time of the elevation models's most recent dataset update, beyond which cached data is invalid. |
protected static void |
setFallbacks(AVList params)
|
void |
setPixelType(String pixelType)
|
protected void |
writeConfigurationFile()
|
protected void |
writeConfigurationParams(AVList params)
|
| Methods inherited from class gov.nasa.worldwind.terrain.AbstractElevationModel |
composeElevations, getElevation, getExpiryTime, getMissingDataReplacement, getMissingDataSignal, getName, isNetworkRetrievalEnabled, setMissingDataReplacement, setMissingDataSignal, setName, setNetworkRetrievalEnabled, toString |
| Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl |
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getStringValue, getStringValue, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues |
| Methods inherited from interface gov.nasa.worldwind.avlist.AVList |
addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValue, setValues |
SERVICE_CAPABILITIES_RESOURCE_ID
protected static final int SERVICE_CAPABILITIES_RESOURCE_ID
- See Also:
- Constant Field Values
BasicElevationModel
public BasicElevationModel(AVList params)
BasicElevationModel
public BasicElevationModel(Document dom,
AVList params)
BasicElevationModel
public BasicElevationModel(Element domElement,
AVList params)
BasicElevationModel
public BasicElevationModel(String restorableStateInXml)
addTileToCache
protected void addTileToCache(BasicElevationModel.ElevationTile tile,
BufferWrapper elevations)
areElevationsInMemory
protected boolean areElevationsInMemory(TileKey key)
checkResources
protected void checkResources()
computeLevelForResolution
public int computeLevelForResolution(Sector sector,
double resolution)
contains
public boolean contains(Angle latitude,
Angle longitude)
- Description copied from interface:
ElevationModel
- Indicates whether a specified location is within the elevation model's domain.
- Specified by:
contains in interface ElevationModel
- Parameters:
latitude - the latitude of the location in question.longitude - the longitude of the location in question.
- Returns:
- true if the location is within the elevation model's domain, otherwise false.
convertImageToElevations
protected static ByteBuffer convertImageToElevations(ByteBuffer buffer,
String contentType)
throws IOException
- Throws:
IOException
countTilesInSector
public int countTilesInSector(Sector sector,
int levelNumber)
createConfigurationDocument
protected Document createConfigurationDocument(AVList params)
createMemoryCache
protected MemoryCache createMemoryCache(String cacheName)
createTile
protected BasicElevationModel.ElevationTile createTile(TileKey key)
doGetRestorableState
protected void doGetRestorableState(RestorableSupport rs,
RestorableSupport.StateObject context)
doGetRestorableStateForAVPair
protected void doGetRestorableStateForAVPair(String key,
Object value,
RestorableSupport rs,
RestorableSupport.StateObject context)
doRestoreState
protected void doRestoreState(RestorableSupport rs,
RestorableSupport.StateObject context)
doRestoreStateForObject
protected void doRestoreStateForObject(RestorableSupport rs,
RestorableSupport.StateObject so)
downloadElevations
protected void downloadElevations(Tile tile)
downloadElevations
protected void downloadElevations(Tile tile,
BasicElevationModel.DownloadPostProcessor postProcessor)
doWriteConfigurationParams
protected void doWriteConfigurationParams(FileStore fileStore,
String fileName,
AVList params)
generateExtremeElevations
public ByteBuffer generateExtremeElevations(int levelNumber)
getBestResolution
public double getBestResolution(Sector sector)
- Description copied from interface:
ElevationModel
- Indicates the best resolution attainable for a specified sector.
- Specified by:
getBestResolution in interface ElevationModel
- Parameters:
sector - the sector in question. If null, the elevation model's best overall resolution is returned. This is
the best attainable at some locations but not necessarily at all locations.
- Returns:
- the best resolution attainable for the specified sector, in radians, or
Double.MAX_VALUE if the
sector does not intersect the elevation model.
getConfigurationParams
protected AVList getConfigurationParams(AVList params)
getDetailHint
public double getDetailHint(Sector sector)
- Description copied from interface:
ElevationModel
- Returns the detail hint associated with the specified sector. If the elevation model does not have any detail
hint for the sector, this will return zero.
- Specified by:
getDetailHint in interface ElevationModel- Overrides:
getDetailHint in class AbstractElevationModel
- Parameters:
sector - the sector in question.
- Returns:
- The detail hint corresponding to the specified sector.
getElevationDataByteOrder
public String getElevationDataByteOrder()
getElevationDataPixelType
public String getElevationDataPixelType()
getElevations
protected BasicElevationModel.Elevations getElevations(Sector sector,
LevelSet levelSet,
int targetLevelNumber)
getElevations
public double getElevations(Sector sector,
List<? extends LatLon> latlons,
double targetResolution,
double[] buffer)
- Description copied from interface:
ElevationModel
- Returns the elevations of a collection of locations.
The missing-data sentinel value, if previously specified, is returned for locations at which an elevation cannot
be determined. if a missing-data value has not been specified, an elevation-model specific value, typically zero,
is returned.
- Specified by:
getElevations in interface ElevationModel
- Parameters:
sector - the sector in question.latlons - the locations to return elevations for. A value of zero is returned if a location is
null.targetResolution - the desired horizontal resolution, in radians, of the raster or other elevation sample
from which elevations are drawn. (To compute radians from a distance, divide the distance
by the radius of the globe, ensuring that both the distance and the radius are in the
same units.)buffer - an array in which to place the returned elevations. The array must be pre-allocated and
contain at least as many elements as the list of locations.
- Returns:
- the resolution achieved, in radians, or
Double.MAX_VALUE if individual elevations cannot be
determined for any of the locations. - See Also:
#setMissingValueSentinel(Double)
getEstimatedMissingDataSize
public long getEstimatedMissingDataSize(Sector sector,
double resolution)
- Get the estimated size in byte of the missing elevation data for the given
Sector and resolution. Note
that the target resolution must be provided in radian latitude per data sample - which is the resolution in meter
divided by the globe radius.
- Specified by:
getEstimatedMissingDataSize in interface BulkRetrievable
- Parameters:
sector - the Sector to estimate.resolution - the target resolution provided in radian latitude per texel.
- Returns:
- the estimated size in byte of the missing imagery.
getExtremeElevations
public double[] getExtremeElevations(Angle latitude,
Angle longitude)
- Description copied from interface:
ElevationModel
- Returns the minimum and maximum elevations at a specified location.
- Specified by:
getExtremeElevations in interface ElevationModel
- Parameters:
latitude - the latitude of the location in question.longitude - the longitude of the location in question.
- Returns:
- A two-element
double array indicating the minimum and maximum elevations at the specified
location, respectively. These values are the global minimum and maximum if the local minimum and maximum
values are currently unknown.
getExtremeElevations
public double[] getExtremeElevations(Sector sector)
- Description copied from interface:
ElevationModel
- Returns the minimum and maximum elevations within a specified sector of the elevation model.
- Specified by:
getExtremeElevations in interface ElevationModel
- Parameters:
sector - the sector in question.
- Returns:
- A two-element
double array indicating the sector's minimum and maximum elevations,
respectively. These elements are the global minimum and maximum if the local minimum and maximum values
are currently unknown.
getExtremes
protected BufferWrapper getExtremes()
getExtremesLevel
protected int getExtremesLevel()
getLevels
public LevelSet getLevels()
getLevelZeroTiles
protected Map<TileKey,BasicElevationModel.ElevationTile> getLevelZeroTiles()
getMaxElevation
public double getMaxElevation()
- Description copied from interface:
ElevationModel
- Returns the maximum elevation contained in the elevevation model. When the elevation model is associated with a
globe, this value is the elevation of the highest point on the globe.
- Specified by:
getMaxElevation in interface ElevationModel
- Returns:
- The maximum elevation of the elevation model.
getMemoryCache
protected MemoryCache getMemoryCache()
getMinElevation
public double getMinElevation()
- Description copied from interface:
ElevationModel
- Returns the minimum elevation contained in the elevevation model. When associated with a globe, this value is the
elevation of the lowest point on the globe. It may be negative, indicating a value below mean surface level. (Sea
level in the case of Earth.)
- Specified by:
getMinElevation in interface ElevationModel
- Returns:
- The minimum elevation of the model.
getParamsFromDocument
protected static AVList getParamsFromDocument(Element domElement,
AVList params)
getRestorableState
public String getRestorableState()
- Description copied from interface:
Restorable
- Returns an XML document string describing the object’s state. This state can be restored later by calling
restoreState and passing the XML document.
- Specified by:
getRestorableState in interface Restorable- Overrides:
getRestorableState in class AbstractElevationModel
- Returns:
- an XML document string describing the object's state.
getTargetLevel
protected Level getTargetLevel(Sector sector,
double targetSize)
getTileFromMemory
protected BasicElevationModel.ElevationTile getTileFromMemory(TileKey tileKey)
getTilesInSector
public Tile[][] getTilesInSector(Sector sector,
int levelNumber)
getUnmappedElevation
public double getUnmappedElevation(Angle latitude,
Angle longitude)
- Description copied from interface:
ElevationModel
- Returns the elevation at a specified location, but without mapping missing data to the elevation model's missing
data replacement value. In the case of missing data values, the missing data signal is returned rather than the
missing data replacement value. *
- Specified by:
getUnmappedElevation in interface ElevationModel
- Parameters:
latitude - the latitude of the location for which to return the elevation.longitude - the longitude of the location for which to return the elevation.
- Returns:
- the elevation at the specified location, or the elevation model's missing data signal. If no data is
currently available for the location, the elevation model's global minimum elevation at that location is
returned.
initializeResources
protected void initializeResources(AVList params)
initPropertiesFromCapabilities
protected void initPropertiesFromCapabilities(Capabilities caps,
AVList params)
initPropertiesFromService
protected void initPropertiesFromService(AVList params)
intersects
public int intersects(Sector sector)
- Description copied from interface:
ElevationModel
- Indicates whether the elevation model corresponds to a specified sector.
- Specified by:
intersects in interface ElevationModel
- Parameters:
sector - the sector in question.
- Returns:
- 0 if the elevation model fully contains the sector, 1 if the elevation model intersects the sector but
does not fully contain it, or -1 if the elevation does not intersect the elevation model.
loadElevations
protected boolean loadElevations(BasicElevationModel.ElevationTile tile,
URL url)
throws IOException
- Throws:
IOException
loadExtremeElevations
public void loadExtremeElevations(String extremesFileName)
lookupElevation
protected double lookupElevation(double latRadians,
double lonRadians,
BasicElevationModel.ElevationTile tile)
makeLocal
public BulkRetrievalThread makeLocal(Sector sector,
double resolution)
- Start a new
BulkRetrievalThread that will try to download all elevation tiles for a given Sector
and resolution. Note that the target resolution must be provided in radian latitude per texel - which is the
resolution in meter divided by the globe radius.
- Specified by:
makeLocal in interface BulkRetrievable
- Parameters:
sector - the Sector to download tiles for.resolution - the target resolution provided in radian latitude per texel.
- Returns:
- the
BulkRetrievalThread that executes the retrieval.
needsConfigurationFile
protected boolean needsConfigurationFile(FileStore fileStore,
String fileName,
AVList params,
boolean removeIfExpired)
readElevations
protected BufferWrapper readElevations(URL url)
throws IOException
- Throws:
IOException
requestTile
protected void requestTile(TileKey key)
restorableStateToParams
protected static AVList restorableStateToParams(String stateInXml)
restoreState
public void restoreState(String stateInXml)
- Description copied from interface:
Restorable
- Restores the object’s state to what is described in the specified XML document string.
- Specified by:
restoreState in interface Restorable- Overrides:
restoreState in class AbstractElevationModel
- Parameters:
stateInXml - an XML document string describing an object's state.
restoreStateForParams
protected static void restoreStateForParams(RestorableSupport rs,
RestorableSupport.StateObject context,
AVList params)
setByteOrder
public void setByteOrder(String byteOrder)
setDetailHint
public void setDetailHint(double hint)
setExpiryTime
public void setExpiryTime(long expiryTime)
- Specifies the time of the elevation models's most recent dataset update, beyond which cached data is invalid. If
greater than zero, the model ignores and eliminates any in-memory or on-disk cached data older than the time
specified, and requests new information from the data source. If zero, the default, the model applies any expiry
times associated with its individual levels, but only for on-disk cached data. In-memory cached data is expired
only when the expiry time is specified with this method and is greater than zero. This method also overwrites the
expiry times of the model's individual levels if the value specified to the method is greater than zero.
- Specified by:
setExpiryTime in interface ElevationModel- Overrides:
setExpiryTime in class AbstractElevationModel
- Parameters:
expiryTime - the expiry time of any cached data, expressed as a number of milliseconds beyond the epoch. The
default expiry time is zero.- See Also:
for a description of milliseconds beyond the epoch.
setFallbacks
protected static void setFallbacks(AVList params)
setPixelType
public void setPixelType(String pixelType)
writeConfigurationFile
protected void writeConfigurationFile()
writeConfigurationParams
protected void writeConfigurationParams(AVList params)
|
|