Main Content

txsite

Create RF transmitter site

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

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

expand all

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

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'

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'.

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 element or array specified as one of these options.

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

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

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]

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:

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:

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:

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

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

showShow site in Site Viewer
hideHide site from Site Viewer
distanceDistance between sites
angleAngle between sites
elevationElevation of site
locationCoordinates at distance and angle from site
losDisplay or compute line-of-sight (LOS) visibility status
coverageDisplay or compute coverage map
sinrDisplay or compute signal-to-interference-plus-noise (SINR) ratio
patternDisplay antenna radiation pattern in Site Viewer

Examples

collapse all

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

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

show(tx)

View the coverage of the antenna.

pattern(tx)

Introduced in R2019b