link

Display or compute communication link status

collapse all in page

Syntax

link(rx,tx)

link(rx,tx,propmodel)

link(___,Name,Value)

status = link(___)

Description

example

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

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

link(___,Name,Value)displays a communication link using additional options specified byName,Valuepairs.

status= link(___)returns the success status of the communication link astrueorfalse.

Examples

collapse all

Communication Link Between Geographic Transmitter and Receiver

Open Live Script

Create a transmitter site.

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

Create a receiver site with a 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)

Communication Link Between Cartesian Transmitter and Receiver

Open Live Script

Import and view an STL file. The file models a small conference room with one table and four chairs.

viewer = siteviewer('SceneModel','conferenceroom.stl');

Create a transmitter site near the upper corner of the room and a receiver site above the table. Specify the position using Cartesian coordinates in meters.

tx = txsite('cartesian',...'AntennaPosition',[-1.46; -1.42; 2.1]); rx = rxsite('cartesian',...'AntennaPosition',[0.3; 0.3; 0.85]);

Plot the communication link between the transmitter and the receiver.

link(rx,tx)

Pan by left-clicking, zoom by right-clicking or by using the scroll wheel, and rotate the visualization by clicking the middle button and dragging or by pressingCtrland left-clicking and dragging.

Input Arguments

collapse all

`rx`—Receiver site
`rxsite`object|array of`rxsite`对象

Receiver site, specified as arxsiteobject. You can use array inputs to specify multiple sites.

`tx`—Transmitter site
`txsite`object|array of`txsite`对象

Transmitter site, specified as atxsiteobject. You can use array inputs to specify multiple sites.

`propmodel`—Propagation model
character vector|string|propagation model created with`propagationModel`

Propagation model, specified as a character vector, a string, or a propagation model created with thepropagationModelfunction. The default value depends on the coordinate system used by the input sites.

Coordinate System	Default 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'`when`Map`is set to the name of an STL file or a triangulation object. The default ray tracing model uses the shooting and bouncing rays (SBR) method.

You can also specify the propagation model by using the'PropagationModel'name-value pair argument.

Name-Value Arguments

Specify optional pairs of arguments asName1=Value1,...,NameN=ValueN, whereNameis the argument name andValueis 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 encloseNamein quotes.

Example:'Type','power'

`PropagationModel`—Propagation model to use for path loss calculations
`'longley-rice'`(default) |`'freespace'`|`'close-in'`|`'rain'`|`'gas'`|`'fog'`|`'raytracing'`|propagation model created with`propagationModel`

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
'longley-rice'— Longley-Rice propagation model
'tirem'— Tirem propagation model
'raytracing'— Ray tracing propagation model that uses the shooting and bouncing rays (SBR) method
A propagation model created with thepropagationModelfunction

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 aCoordinateSystemvalue of'geographic'.

Data Types:char

`SuccessColor`—Color of successful links
`'green'`(default) |RGB triplet|character vector|string scalar

Color of successful links, specified as the comma-separated pair consisting of'SuccessColor'and one of the following:

An RGB triplet whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range[0,1]; for example,[0.4 0.6 0.7].
A character vector such as“红色”or'r'.
A string scalar such as"red"or"r".

This table contains the color names and equivalent RGB triplets for some common colors.

Color Name	Short Name	RGB Triplet
`“红色”`	`'r'`	`[1 0 0]`
`'green'`	`'g'`	`[0 1 0]`
`'blue'`	`'b'`	`[0 0 1]`
`'cyan'`	`'c'`	`[0 1 1]`
`'magenta'`	`'m'`	`[1 0 1]`
`'yellow'`	`'y'`	`[1 1 0]`
`'black'`	`'k'`	`[0 0 0]`
`'white'`	`'w'`	`[1 1 1]`

Data Types:char|string|double

`FailColor`—Color of unsuccessful links
`“红色”`(default) |RGB triplet|character vector|string scalar

Color of unsuccessful links, specified as the comma-separated pair consisting of'FailColor'and one of the following:

An RGB triplet whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range[0,1]; for example,[0.4 0.6 0.7].
A character vector such as“红色”or'r'.
A string scalar such as"red"or"r".

This table contains the color names and equivalent RGB triplets for some common colors.

Color Name	Short Name	RGB Triplet
`“红色”`	`'r'`	`[1 0 0]`
`'green'`	`'g'`	`[0 1 0]`
`'blue'`	`'b'`	`[0 0 1]`
`'cyan'`	`'c'`	`[0 1 1]`
`'magenta'`	`'m'`	`[1 0 1]`
`'yellow'`	`'y'`	`[1 1 0]`
`'black'`	`'k'`	`[0 0 0]`
`'white'`	`'w'`	`[1 1 1]`

Data Types:char|string|double

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

Map for visualization or surface data, specified as asiteviewerobject, atriangulationobject, 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'`的名称,或者定制的地形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'`.
^aAlignment 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

`status`— Success status of communication link
M-by-Narray

Success status of communication links, returned as anM-by-Narrays.Mis the number of transmitter sites andNis the number of receiver sites.

Version History

Introduced in R2017b

expand all

R2021b:`'raytracing'`propagation models use SBR method

Behavior changed in R2021b

Starting in R2021b, when you use thelinkfunction and specify thepropmodelargument orPropagationModelname-value argument as'raytracing', the function uses the shooting and bouncing rays (SBR) method and calculates up to two reflections. In previous releases, thelinkfunction uses the image method and calculates up to one reflection.

To display or compute communication link status using the image method instead, create a propagation model by using thepropagationModelfunction. Then, use thelinkfunction with the propagation model as input. This example shows how to update your code.

pm = propagationModel('raytracing','Method','image'); link(rx,tx,pm)

For information about the SBR and image methods, seeChoose a Propagation Model.

Starting in R2021b, all RF Propagation functions use the SBR method by default and calculate up to two reflections. For more information, seeDefault modeling method is shooting and bouncing rays method.

link

Syntax

Description

Examples

Communication Link Between Geographic Transmitter and Receiver

Communication Link Between Cartesian Transmitter and Receiver

Input Arguments

rx—Receiver siterxsiteobject|array ofrxsite对象

tx—Transmitter sitetxsiteobject|array oftxsite对象

propmodel—Propagation modelcharacter vector|string|propagation model created withpropagationModel

Name-Value Arguments

PropagationModel—Propagation model to use for path loss calculations'longley-rice'(default) |'freespace'|'close-in'|'rain'|'gas'|'fog'|'raytracing'|propagation model created withpropagationModel

SuccessColor—Color of successful links'green'(default) |RGB triplet|character vector|string scalar

FailColor—Color of unsuccessful links“红色”(default) |RGB triplet|character vector|string scalar

Map—Map for visualization or surface datasiteviewerobject|triangulationobject|string scalar|character vector

Output Arguments

status— Success status of communication linkM-by-Narray

Version History

R2021b:'raytracing'propagation models use SBR method

See Also

`rx`—Receiver site
`rxsite`object|array of`rxsite`对象

`tx`—Transmitter site
`txsite`object|array of`txsite`对象

`propmodel`—Propagation model
character vector|string|propagation model created with`propagationModel`

`PropagationModel`—Propagation model to use for path loss calculations
`'longley-rice'`(default) |`'freespace'`|`'close-in'`|`'rain'`|`'gas'`|`'fog'`|`'raytracing'`|propagation model created with`propagationModel`

`SuccessColor`—Color of successful links
`'green'`(default) |RGB triplet|character vector|string scalar

`FailColor`—Color of unsuccessful links
`“红色”`(default) |RGB triplet|character vector|string scalar

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

`status`— Success status of communication link
M-by-Narray

R2021b:`'raytracing'`propagation models use SBR method