link

Display communication link on map

Description

example

link(rx,tx) plots a one-way point-to-point communication link between a receiver site and transmitter site. The plot is color coded to identify the link success status.

link(rx,tx,propmodel) plots the communication link based on the specified propagation model.

link(___,Name,Value)plots a communication link using additional options specified by Name,Value pairs.

status = link(___) returns the success status of the communication link as true or false.

Examples

collapse all

Create a transmitter site.

tx = txsite('Name','MathWorks', ...
        'Latitude', 42.3001, ...
        'Longitude', -71.3503);

Create a receiver site with sensitivity defined in dBm.

 rx = rxsite('Name','Boston', ...
        'Latitude', 42.3601, ...
        'Longitude', -71.0589, ...
        'ReceiverSensitivity', -90);

Plot the communication link between the transmitter and the receiver.

link(rx,tx)

Input Arguments

collapse all

Receiver site, specified as a rxsite object. You can use array inputs to specify multiple sites.

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

Propagation model, specified as a character vector or string. You can use the propagationModel function to define this input. The default value depends on the coordinate system used by the input sites:

Coordinate SystemDefault propagation model value
'geographic'
  • 'longley-rice' when you use a terrain.

  • 'freespace' when you do not use a terrain.

'cartesian'
  • 'freespace' when Map is set to none.

  • 'raytracing-image-method' when Map is set to the name of an STL file or a triangulation object.

You can also use the name-value pair 'PropagationModel' to specify this parameter.

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: 'Type','power'

Propagation model to use for the path loss calculations, specified as the comma-separated pair consisting of 'PropagationModel' and one of the following:

  • 'freespace' - Free space propagation model

  • 'rain' - Rain propagation model

  • 'gas' - Gas propagation model

  • 'fog' - Fog propagation model

  • 'close-in' - Close-in propagation model

  • 'lonley-rice' - Longely-Rice propagation model

  • 'tirem' - Tirem propagation model

  • 'ray-tracing-image-method' - -Raytracing propagation model using method of images.

The default propagation model is 'longley-rice' when terrain is enabled and 'freespace' when terrain is disabled.

Terrain propagation models including 'longley-rice' and 'tirem' are only supported for sites with CoordinateSystem property set to 'geographic'.

Data Types: char

Color of successful links, specified as the comma-separated pair consisting of 'SuccessColor and an RGB triplet or character vector. For more information, see ColorSpec (Color Specification).

Data Types: char | double

Color of unsuccessful links, specified as the comma-separated pair consisting of 'FailColor and RGB triplet or character vector. For more information, see ColorSpec (Color Specification).

Data Types: char | double

Map for visualization or surface data, specified as the comma-separated pair consisting of 'Map and one of the following depending on the coordinate system:

Coordinate SystemValid map valuesDefault map value
'geographic'
  • siteviewer[a]

  • A terrain name may be specified 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

  • current siteviewer or new siteviewer if none are open.

  • 'gmted2010' if called with an output.

'cartesian''none', triangulation object or name of an STL file.'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

Success status of communication links, returned as an M-by-N arrays. M is the number of transmitter sites and N is the number of receiver sites.

Introduced in R2017b