txsite

Create RF transmitter site

Since R2019b

Description

Use the txsite object to create a radio frequency transmitter site.

A transmitter consists of an RF circuit and an antenna, where the RF circuit excites the antenna with a signal and power. Key characteristics of a transmitter include its output power, operating frequency, and antenna radiation pattern.

Creation

Syntax

tx = txsite

tx = txsite(coordsys)

tx = txsite(___,Name,Value)

Description

tx = txsite creates a radio frequency transmitter site.

tx = txsite(coordsys) creates a transmitter site with the specified coordinate system. You can specify either 'geographic' or 'cartesian' coordinate system.

tx = txsite(___,Name,Value) sets properties using one or more name-value pairs. For example, tx = txsite('Name','TX Site') creates a transmitter site with the name TX Site. Enclose each property name in quotes.

You can create multiple transmitter sites by using Name, Latitude, and Longitude properties. For example: names = ["Fenway Park","Faneuil Hall","Bunker Hill Monument"]; lats = [42.3467,42.3598,42.3763]; lons = [-71.0972,-71.0545,-71.0611];. The CoordinateSystem property must be a string scalar or a character vector.

Properties

Name — Site name

character vector | string | row or column vector

Site name, specified as a character vector or string or as a row or column vector of N elements. Specifying name as a row or column vector creates multiple sites.

Example: 'Name','Site 2'

Example: tx.Name = 'Fenway Park'

Example: names = ["Fenway Park","Faneuil Hall","Bunker Hill Monument"]; tx = txsite('Name',names)

Data Types: char | string

CoordinateSystem — Coordinate system used to site location

'geographic' (default) | 'cartesian'

Coordinate system used to the site location, specified as 'geographic' or 'cartesian'. If you specify 'geographic', the site location is defined using the Latitude, Longitude, and AntennaHeight properties. If you specify 'cartesian', the site location is defined using the AntennaPosition property.

Example: 'CoordinateSystem','cartesian'

Example: tx.CoordinateSystem = 'cartesian'

Latitude — Site latitude coordinates

42.3001 (default) | numeric scalar in the range [-90 90] | row or column vector

Site latitude coordinates, specified as a numeric scalar in the range of -90 to 90, or as a row or column vector of N elements in the range [-90 90]. Specifying latitude as a row or column vector creates multiple sites. The coordinates are defined using the world geodesic system of 1984 (WGS-84) reference ellipsoid. Latitude specifies north-south position.

Example: 'Latitude',45.098

Example: tx.Latitude = 45.098

Example: latitude = [42.3467,42.3598,42.3763]; tx = txsite('Latitude',latitude)

Dependencies

To enable this property, set CoordinateSystem to 'geographic'.

Longitude — Site longitude coordinates

-71.3504 (default) | numeric scalar in the range [-180 180] | row or column vector

Site longitude coordinates, specified as a numeric scalar in the range [-180 180]or as a row or column vector of N elements in the range [-180 180]. Specifying longitude as a row or column vector creates multiple sites. The coordinates are defined using the world geodesic system of 1984 (WGS-84) reference ellipsoid. Longitude specifies the east-west the position.

Example: 'Longitude',-68.890

Example: tx.Longitude = -71.0972

Example: longitude = [-71.0972,-71.0545,-71.0611]; tx = txsite('Longitude',longitude)

Dependencies

To enable this property, set the CoordinateSystem to 'geographic'.

Antenna — Antenna element or array

'isotropic' (default) | object | row vector

Antenna element or array specified as one of these options.

• 'isotropic' to model an antenna that radiates uniformly in all directions.

• An arrayConfig object.

• If you have Antenna Toolbox™, an antenna element from the Antenna Catalog (Antenna Toolbox).

• If you have Phased Array System Toolbox™, any antenna object in Antennas, Microphones, and Sonar Transducers (Phased Array System Toolbox) or any array object in Array Geometries and Analysis (Phased Array System Toolbox).

Example: 'Antenna',cfgArray, where cfgArray is an arrayConfig object

Example: tx.Antenna = arrayConfig('Size',[8 1]); specifies an 8-element ULA along z-axis

AntennaAngle — Antenna X-axis angle

0 (default) | numeric scalar | 2-by-1 vector | 2-by-N matrix

Antenna X-axis angle defined with reference to a local Cartesian coordinate system, specified as a numeric scalar representing an azimuth angle in degrees or as a 2-by-1 vector or a 2-by-N matrix representing both azimuth and elevation angles with each element unit in degrees.

The azimuth angle is measured counterclockwise from the east along the antenna X-axis (for geographical sites) or from the global X-axis around the global Z-axis (for Cartesian sites). Specify the azimuth angle between -180 to 180. degrees.

The elevation angle is measured from antenna X-axis along the horizontal or XY plane. Specify the elevation angle between-90 to 90 degrees.

Example: 'AntennaAngle',25

Example: tx.AntennaAngle = [25,-80]

AntennaHeight — Antenna height above surface

10 (default) | nonnegative numeric scalar | row vector

Antenna height from the ground or building surface, specified as a nonnegative numeric scalar in meters. Maximum value for this property is 6,371,000 m.

If the site location coincides with the building location, the antenna height is measured from the top of the building to the center of the antenna. Otherwise,the height is measured from ground elevation to the center of the antenna.

Example: 'AntennaHeight',25

Example: tx.AntennaHeight = 15

Dependencies

To enable this property, set CoordinateSystem to 'geographic'.

Data Types:

AntennaPosition — Position of antenna center

[0;0;0] (default) | 3-by-1 vector

Position of the antenna center, specified as a 3-by-1 vector representing X-, Y-, and Z-axis Cartesian coordinates with each element in meters.

Example: 'AntennaPosition',[0;2;4]

Example: tx.AntennaPosition = [0;2;4]

Dependencies

To enable this property, set CoordinateSystem to 'cartesian'.

Data Types:

SystemLoss — System loss

0 (default) | nonnegative scalar | row vector

System loss, specified as a nonnegative scalar in dB.

System loss includes transmission line loss and any other miscellaneous system losses.

Example: 'SystemLoss',10

Example: txsite.SystemLoss = 10

Data Types:

TransmitterFrequency — Transmitter operating frequency

1.9000e+09 (default) | positive scalar | row vector

Transmitter operating frequency, specified as a positive scalar in Hz in the range [1e3 200e9].

Example: 'TransmitterFrequency',30e9

Example: txsite.TransmitterFrequency = 30e9

Data Types: double

TransmitterPower — Signal power at transmitter output

10 (default) | positive scalar

Signal power at transmitter output, specified as a positive scalar in watts. The transmitter out is connected to the antenna.

Example: 'TransmitterPower',30

Example: txsite.TransmitterPower = 30

Data Types: double

Object Functions

show	Show site in Site Viewer
hide	Hide site from Site Viewer
distance	Distance between sites
angle	Angle between sites
elevation	Elevation of site
location	Coordinates at distance and angle from site
los	Display or compute line-of-sight (LOS) visibility status
coverage	Display or compute coverage map
sinr	Display or compute signal-to-interference-plus-noise (SINR) ratio
pattern	Display antenna radiation pattern in Site Viewer

Examples

Default Transmitter Site

Create a transmitter site at a latitude of 42.3001 degrees and a longitude of -71.3504 degrees.

tx = txsite("Name","MathWorks Apple Hill", ...
    "Latitude",42.3001,"Longitude",-71.3504)

tx = 
  txsite with properties:

                    Name: 'MathWorks Apple Hill'
        CoordinateSystem: 'geographic'
                Latitude: 42.3001
               Longitude: -71.3504
                 Antenna: 'isotropic'
            AntennaAngle: 0
           AntennaHeight: 10
              SystemLoss: 0
    TransmitterFrequency: 1.9000e+09
        TransmitterPower: 10

View the coverage of the site.

pattern(tx)

Version History

Introduced in R2019b