distance

Distance between sites

collapse all in page

Syntax

d = distance(site1,site2)

d = distance(site1,site2,path)

d = distance(___,Name,Value)

Description

d = distance(site1,site2) returns the distance in meters between site1 and site2.

example

d = distance(site1,site2,path) returns the distance using a specified path type, either a Euclidean or great circle path.

d = distance(___,Name,Value) returns the distance with additional options specified by name-value arguments.

Examples

collapse all

Distance Between Transmitter and Receiver Site

Open Live Script

Create transmitter and receiver sites.

tx = txsite('Name','MathWorks','Latitude',42.3001,'Longitude',-71.3504);
rx = rxsite('Name','Fenway Park','Latitude',42.3467,'Longitude',-71.0972);

Get the Euclidean distance in km between the sites.

dme = distance(tx,rx)

dme = 2.1504e+04

dkm = dme / 1000

dkm = 21.5037

Get the great circle distance between the two sites.

dmg = distance(tx,rx,'greatcircle')

dmg = 2.1451e+04

Input Arguments

collapse all

`site1,site2` — Transmitter or receiver site
`txsite` object | `rxsite` object

Transmitter or receiver site, specified as a txsite or rxsite object. You can use array inputs to specify multiple sites.

`path` — Measurement path type
`'euclidean'` | `'greatcircle'`

Measurement path type, specified as one of the following:

'euclidean' — Use the shortest path through space that connects the antenna center positions of the sites.
'greatcircle' — Use the shortest path on the surface of the earth that connects the latitude and longitude locations of the sites. This path uses a spherical Earth model.

Data Types: char

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Map','siteviewer1'

`Map` — Map for visualization or surface data
`siteviewer` object | `triangulation` object | string scalar | character vector

Map for visualization or surface data, specified as a siteviewer object, a triangulation object, a string scalar, or a character vector. Valid and default values depend on the coordinate system.

Coordinate System	Valid map values	Default map value
`"geographic"`	A `siteviewer` object^a. A terrain name, if the function is called with an output argument. Valid terrain names are `"none"`, `"gmted2010"`, or the name of the custom terrain data added using `addCustomTerrain`.	The current `siteviewer` object or a new `siteviewer` object if none are open. `"gmted2010"`, if the function is called with an output.
`"cartesian"`	`"none"`. A `siteviewer` object. The name of an STL file. A `triangulation` object.	`"none"`.
^a Alignment of boundaries and region labels are a presentation of the feature provided by the data vendors and do not imply endorsement by MathWorks^®.

Data Types: char | string

Output Arguments

collapse all

`d` — Distance between sites
M-by-N numeric array

Distance between sites, returned as an M-by-N numeric array in meters, where M is the number of sites in site2 and N is the number of sites in site1.