txsite

Create radio frequency transmitter site

Description

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

Creation

Description

example

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.

example

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:

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

  • An antenna element object from the Antenna Catalog

    Note

    When using the antenna element object, use the design

    function to design the antenna at the required transmit frequency. Then add this antenna element to the transmitter site.

  • An array element from the Array Catalog

  • An arrayConfig (Communications Toolbox) object if you have Communications Toolbox™

  • Any antenna object in Antennas, Microphones, and Sonar Transducers (Phased Array System Toolbox), if you have Phased Array System Toolbox™

  • Any array object in Array Geometries and Analysis (Phased Array System Toolbox), if you have Phased Array System Toolbox

Example: 'Antenna',monopole

Example: tx.Antenna = monopole

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 location on map
hideHide site location on map
distanceDistance between sites
angleAngle between sites
elevationElevation of site
locationLocation coordinates at a given distance and angle from site
losPlot or compute the line-of-sight (LOS) visibility between sites on a map
coverageDisplay coverage map
sinrDisplay signal-to-interference-plus-noise ratio (SINR) map
patternPlot antenna radiation pattern on map

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

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

fq = 2.5e9
fq = 2.5000e+09
tx = txsite('Name','MathWorks Apple Hill','Antenna',dipole,'Latitude',42.3001,...
    'Longitude',-71.3504,'Antenna',design(dipole,fq),'TransmitterFrequency',fq)
tx = 
  txsite with properties:

                    Name: 'MathWorks Apple Hill'
                Latitude: 42.3001
               Longitude: -71.3504
                 Antenna: [1×1 dipole]
            AntennaAngle: 0
           AntennaHeight: 10
              SystemLoss: 0
    TransmitterFrequency: 2.5000e+09
        TransmitterPower: 10

show(tx);

Specify the names, latitudes, and longitudes of three transmitter locations.

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

Define the frequency of the transmitters.

fq = 2.5e9;

Create and view the transmitter array using a dipole antenna.

txs = txsite('Name', names,...
'Antenna',dipole,'Latitude',lats,...
'Longitude',lons, ...
'TransmitterFrequency',fq);
show(txs)

See Also

|

Introduced in R2017b