# sinr

Display or compute signal-to-interference-plus-noise (SINR) ratio

## Syntax

``sinr(txs)``
``sinr(txs,propmodel)``
``sinr(___,Name,Value)``
``pd = sinr(txs,___)``
``r = sinr(rxs,txs,___)``

## Description

example

````sinr(txs)` displays the signal-to-interference-plus-noise ratio (SINR) for transmitter sites `txs` in the current Site Viewer. The map contours are generated using SINR values computed for receiver site locations on the map. For each location, the signal source is the transmitter site in TXS with the greatest signal strength. The remaining transmitter sites in `txs` with the same transmitter frequency act as sources of interference. If `txs` is scalar or there are no sources of interference the resultant map displays signal-to-noise ratio (SNR).This function only supports plotting for antenna sites with a `CoordinateSystem` property value of `'geographic'`.```
````sinr(txs,propmodel)` displays the SINR map with the propagation model set to the value in `propmodel`.```
````sinr(___,Name,Value)` sets properties using one or more name-value pairs, in addition to the input arguments in previous syntaxes. For example, `sinr(txs,'MaxRange',8000)` sets the range from the site location at 8000 meters to include in the SINR map region.```
````pd = sinr(txs,___)` returns computed SINR data in the propagation data object, `pd`. No plot is displayed and any graphical only name-value pairs are ignored.```
````r = sinr(rxs,txs,___)` returns the `sinr` in dB computed at the receiver sites due to the transmitter sites.```

## Examples

collapse all

Define names and location of sites in Boston.

```names = ["Fenway Park","Faneuil Hall","Bunker Hill Monument"]; lats = [42.3467,42.3598,42.3763]; lons = [-71.0972,-71.0545,-71.0611];```

Create a transmitter site array.

```txs = txsite('Name', names,... 'Latitude',lats,... 'Longitude',lons, ... 'TransmitterFrequency',2.5e9);```

Display the SINR map, where signal source for each location is selected as the transmitter site with the strongest signal.

`sinr(txs)`

## Input Arguments

collapse all

Transmitter site, specified as a `txsite` object. Use array inputs to specify multiple sites.

This function only supports plotting antenna sites when `CoordinateSystem` property is set to `'geographic'`.

Receiver site, specified as a `rxsite` object. Use array inputs to specify multiple sites.

This function only supports plotting antenna sites when `CoordinateSystem` property is set to `'geographic'`.

Propagation model, specified as a character vector, a string, or a propagation model created with the `propagationModel` function. 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'` 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 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: `'MaxRange',8000`
General

collapse all

Signal source of interest, specified as the comma-separated pair consisting of `SignalSource` and `'strongest'` or as a transmitter site object. When the signal source of interest is `'strongest'`, the transmitter with the greatest signal strength is chosen as the signal source of interest for that location. When computing `sinr`, `SignalSource` can be a `txsite` array with equal number of elements `rxs` where each transmitter site element defines the signal source for the corresponding receiver site.

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 the `propagationModel` function

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 a `CoordinateSystem` value of `'geographic'`.

Data Types: `char`

Total noise power at receiver, specified as the comma-separated pair consisting of `'ReceiverNoisePower'` and a scalar in dBm. The default value assumes that the receiver bandwidth is 1 MHz and receiver noise figure is 7 dB.

`$N=-174+10*\mathrm{log}\left(B\right)+F$`

where,

• N = Receiver noise in dBm

• B = Receiver bandwidth in Hz

• F = Noise figure in dB

Mobile receiver gain, specified as the comma-separated pair consisting of `'ReceiverGain'` and a scalar in dB. The receiver gain values include the antenna gain and the system loss. If you call the function using an output argument, the default value is computed using `rxs`.

Receiver antenna height above the ground, specified as the comma-separated pair consisting of `'ReceiverAntennaHeight'` and a scalar in meters. If you call the function using an output argument, the default value is computed using `rxs`.

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 SystemValid map valuesDefault map value
`'geographic'`
• 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] 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`

For Plotting SINR

collapse all

Values of SINR for display, specified as the comma-separated pair consisting of `'Values'` and a numeric vector. Each value is displayed as a different colored, filled on the contour map. The contour colors are derived using `Colormap` and `ColorLimits`.

Maximum range of coverage map from each transmitter site, specified as a positive numeric scalar in meters representing great circle distance. `MaxRange` defines the region of interest on the map to plot. The default value is automatically computed based on the type of propagation model.

Type of Propagation ModelMaxRange
Atmospheric or empirical`30` km
Terrain`30` km or distance to the furthest building.
Ray tracing`500` m

Data Types: `double`

Resolution of receiver site locations used to compute SINR values, specified as the comma-separated pair consisting of `'Resolution'` and `'auto'` or a numeric scalar in meters. The resolution defines the maximum distance between the locations. If the resolution is `'auto'`, `sinr` computes a value scaled to `MaxRange`. Decreasing the resolution increases the quality of the SINR map and the time required to create it.

Colormap for coloring filled contours, specified as the comma-separated pair consisting of `'ColorMap'` and an M-by-`3` array of RGB triplets, where M is the number of individual colors.

Color limits for color maps, specified as the comma-separated pair consisting of `'ColorLimits'` and a two-element vector of the form [min max]. The color limits indicate the SINR values that map to the first and last colors in the colormap.

Show signal strength color legend on map, specified as the comma-separated pair consisting of `'ShowLegend'` and `'true'` or `'false'`.

Transparency of SINR map, specified as the comma-separated pair consisting of `'Transparency'` and a numeric scalar in the range 0–1. If the value is zero, the map is completely transparent. If the value is one, the map is completely opaque.

## Output Arguments

collapse all

Signal to interference plus noise ratio at the receiver due to the transmitter sites, returned as a numeric vector. The vector length is equal to the number of receiver sites.

Data Types: `double`

SINR data, returned as a `propagationData` object consisting of Latitude and Longitude, and a signal strength variable corresponding to the plot type. Name of the `propagationData` is ```"SINR Data"```.

## Compatibility Considerations

expand all

Behavior changed in R2021b