Main Content

addCustomTerrain

Add custom terrain data

Description

example

addCustomTerrain(terrainName,files) adds the terrain data specified with a user-defined terrainName and files. You can use this function to add custom terrain data in Site Viewer and other RF propagation functions. You can access the custom terrain data in the current and future sessions of MATLAB® until you call removeCustomTerrain.

Note

In Antenna Toolbox™, addCustomTerrain function converts terrain elevation data from orthometric to ellipsoidal for visualization and when performing Euclidean distance or angle calculations between locations for example for free space path loss.

addCustomTerrain(___,Name,Value) adds custom terrain data with additional options specified by one or more name-value pairs.

Examples

collapse all

Add terrain for a region around Boulder, CO. The DTED file was downloaded from the "SRTM Void Filled" data set available from the U.S. Geological Survey.

dtedfile = "n39_w106_3arc_v2.dt1";
attribution = "SRTM 3 arc-second resolution. Data available " + ...
   "from the U.S. Geological Survey.";
addCustomTerrain("southboulder",dtedfile,"Attribution",attribution)

Use the custom terrain name in Site Viewer.

viewer = siteviewer("Terrain","southboulder");

Create a site with the terrain region.

mtzion = txsite("Name","Mount Zion", ...
   "Latitude",39.74356, ...
   "Longitude",-105.24193, ...
   "AntennaHeight", 30);
show(mtzion)

Create a coverage map of the area within 20 km of the transmitter site.

coverage(mtzion, ...
   "MaxRange",20000, ...
   "SignalStrengths",-100:-5)

Remove the custom terrain.

close(viewer)
removeCustomTerrain("southboulder")

Input Arguments

collapse all

User-defined identifier for terrain data, specified as a string scalar or a character vector.

Data Types: char | string

List of DTED files, specified as a string scalar, a character vector or a cell array of character vectors.

Note

If you specify multiple files, they must combine to define a complete rectangular geographic region. If not, you must set the name-value pair 'FillMissing' to 'true'.

Data Types: char | string

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'FillMissing',true

Attribution of custom terrain data, specified as a character vector or a string scalar. The attribution is displayed on the Site Viewer map. By default, the value is empty.

Data Types: char | string

Fill data of missing files with value 0, specified as true or false. Missing file values are required to complete a rectangular geographic region with the input files.

Data Types: logical

Name of folder to write extracted terrain files to, specified as a character vector or a string scalar. The folder must exist and have write permissions. By default, addCustomTerrain writes extracted terrain files to a temporary folder that it generates using the tempname function.

Data Types: char | string

Introduced in R2019a