link

Display communication link on map

collapse all in page

Syntax

link(rx,tx)
link(rx,tx,propmodel)
link(___,Name,Value)
status = link(___)

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

Open Live Script

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 also use the name-value pair 'PropagationModel' to specify this parameter.

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

Propagation model to use for the path loss calculations, specified as the comma-separated pair consisting of 'PropagationModel' and 'freespace', 'close-in', 'rain', 'gas', 'fog', 'longley-rice', 'raytracing-image-method', or as an object created using the propagationModel function. The default propagation model is 'longeley-rice' when terrain is enabled and 'freespace' when terrain is disabled. If 'raytracing-image-method' is specified, the value of 'MaxNumReflections' property must be lesser than 1.

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 a siteviewer object or a terrain name. 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. The default value is the current Site Viewer. If no Site Viewer is open, the default value is a new Site Viewer or else 'gmted2010' if the function is called with an output argument.

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.

See Also

| | | |

Topics

Introduced in R2017b

Antenna Toolbox Documentation
Support