Engee documentation

EngeePhased.CustomAntennaElement

A custom antenna.

Library

EngeePhased

Description

System object EngeePhased.CustomAntennaElement simulates an antenna element with a custom spatial radiation pattern. The radiation pattern can be defined for polarized or unpolarized fields.

To create and use a custom antenna, follow these steps:

  1. Create an object EngeePhased.CustomAntennaElement and set its properties.

  2. Call the object with arguments as if it were a function.

To learn more about how to work with system objects, see Engee System Objects.

Syntax

Creation

  • antenna = EngeePhased.CustomAntennaElement() — creates an antenna element with default property values. By default, the radiation pattern model is spatially isotropic.

  • antenna = EngeePhased.CustomAntennaElement(Name=Value) — creates a custom antenna element with the specified properties in the form of a pair Name=Value, where Name — the name of the property, and Value — the appropriate value. You can specify multiple pairs «name-value» the order of the pairs does not matter. Unspecified properties retain their default values. For example, the output radiation pattern of an antenna depends on whether the polarization is set or not.

Using

  • RESP = antenna(FREQ,ANG) — returns the antenna radiation pattern RESP at the operating frequencies FREQ in the directions ANG. The type of the RESP argument depends on whether the antenna element supports polarization.:

    • If for a property SpecifyPolarizationPattern the value is set false, then RESP is a matrix on , containing a radiation pattern of the antenna at the operating frequencies FREQ in the directions ANG.

    • If for a property SpecifyPolarizationPattern the value is set true, then it is a tuple containing two fields RESP.H and RESP.V, representing the antenna pattern in horizontal and vertical polarization, respectively. Each field is a matrix on , containing a radiation pattern of the antenna at the operating frequencies FREQ in the directions ANG.

When an object is first started, it is initialized. This initialization locks immutable properties and input parameters such as dimension, complexity, and data type of the input data. If you change an immutable property or an input parameter, the system object will return an error. To change immutable properties or input data, you must first call the method release! to unlock an object.

Arguments

Input arguments

FREQ — the operating frequencies of the antenna element

+ scalar | vector is a string of length L

Details

The antenna’s operating frequencies, specified as a real positive scalar or a real vector, are strings of length containing positive numbers.

Typical values are in the range FrequencyVector. Otherwise, the element does not have a directional pattern and returns it as −Inf.

The units of measurement are Hz.

Типы данных

Float64

ANG — azimuth angle and angle of the radiation pattern location

+ vector is a string of length M | the 2 by M matrix

Details

The directions of the radiation pattern, specified as a real vector, are strings of length or a real matrix on .

If ANG is a matrix, then each column defines a direction in the form [azimuth; elevation]. The azimuthal angle should be in the range of −180° before 180° inclusive. The angle of the seat should be in the range of −180° before 180° inclusive.

If ANG is a string vector, each element sets the azimuth angle of the direction. In this case, the corresponding seat angle is assumed to be 0°.

The units of measurement are degrees.

For more information about the azimuth angle and the location angle, see Azimuthal angles and location angles.

Типы данных

Float64

Output arguments

RESP — antenna pattern

+ the complex matrix M on L

Details

The radiation pattern of the antenna element, returned as a complex matrix on , where — the number of angles specified in ANG, — the number of frequencies specified in FREQ.

Features

# FrequencyVector is a vector of the operating frequency range

+ [0 1e20] (by default) | a non-negative real vector is row 1 on L

Details

The frequencies at which the frequency characteristics and antenna patterns are to be obtained, specified as a non-negative real vector string on . The elements of the vector must be arranged in ascending order. The antenna element does not have a radiation pattern outside the frequency range specified by the minimum and maximum elements of the frequency vector.

The units of measurement are Hz.

# FrequencyResponse — frequency characteristics of the antenna element

+ [0 0] (by default) | real vector 1 on L

Details

Frequency characteristics at frequencies defined by the property FrequencyVector, set as a string vector on , where — length of the FrequencyVector vector.

The units of measurement are dB.

# PatternCoordinateSystem is the coordinate system of the custom antenna pattern

+ "az-el" (by default) | "phi-theta"

Details

The coordinate system of the custom antenna pattern, specified as "az-el" or "phi-theta".

If you set the PatternCoordinateSystem property to "az-el", use the properties AzimuthAngles and ElevationAngles to specify the coordinate system of the directional pattern.

If you set the PatternCoordinateSystem property to "phi-theta", use the properties PhiAngles and ThetaAngles to specify the coordinate system of the directional pattern.

# AzimuthAngles — azimuth angles

+ −180:180 (by default) | a real vector of length P

Details

Azimuthal angles, defined as a vector of length . A custom directional pattern is set for these angles.

Vector length There should be more 2. Azimuth angles should be in the range of −180° before 180° and be arranged in strictly ascending order.

The units of measurement are degrees.

Dependencies

To use this property, set the PatternCoordinateSystem value az-el.

# ElevationAngles — corners of the place

+ [-90:90] (by default) | a real vector of length Q

Details

The angles of the place, defined as a vector of length . A custom directional pattern is set for these angles.

Vector length There should be more 2. The angles of the seat should be in the range of −90° before 90° and be arranged in strictly ascending order.

The units of measurement are degrees.

Dependencies

To use this property, set the PatternCoordinateSystem value az-el.

# PhiAngles — Phi angles in the phi-theta coordinate system

+ 0:360 (default) | a real vector of length P

Details

The phi angles, defined as a real vector of length . The phi angles must be in the range of 0° before 360°. Vector length There should be more 2.

A custom directional pattern is set for these angles in the phi-theta coordinate system.

Dependencies

To use this property, set the PatternCoordinateSystem value phi-theta.

# ThetaAngles — theta is the angle in the coordinate system phi-theta

+ 0:180 (by default) | a real vector of length Q

Details

The theta angles, defined as a real vector of length . The angles of theta must be in the range of 0° before 180°. Vector length There should be more 2.

A custom directional pattern is set for these angles in the phi-theta coordinate system.

Dependencies

To use this property, set the PatternCoordinateSystem value phi-theta.

# SpecifyPolarizationPattern — polarized radiation pattern

+ false (by default) | true

Details

The polarized radiation pattern, defined as false or true.

  • If the SpecifyPolarizationPattern property is set to false The antenna element transmits or receives unpolarized radiation. In this case, use the MagnitudePattern to set the antenna pattern.

  • If the SpecifyPolarizationPattern property is set to true The antenna element transmits or receives polarized radiation. In this case, use the properties HorizontalMagnitudePattern and HorizontalPhasePattern to set the horizontal polarization pattern and property VerticalMagnitudePattern and VerticalPhasePattern for setting the directional pattern of vertical polarization.

# MagnitudePattern is the amplitude of the radiation pattern of the combined antenna

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The amplitude of the radiation pattern of the combined polarization antenna, set as a matrix on or an array on on .

The units of amplitude measurement are dB.

  • If the value of the MagnitudePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the MagnitudePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

If the directional pattern contains the value NaN in any direction along the azimuth and angle of the location, it is converted to Inf pointing to the zero directional pattern in that direction.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value false.

# PhasePattern is the phase of the radiation pattern of the combined antenna

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The phase of the radiation pattern of the combined polarization antenna, set as a matrix on or an array on on .

The units of measurement of the phase are degrees.

  • If the value of the PhasePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the PhasePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value false.

# HorizontalMagnitudePattern is the amplitude of the horizontal polarization component of the antenna radiation pattern

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The amplitude of the horizontal polarization component of the antenna radiation pattern, set as a matrix on or an array on on .

The units of amplitude measurement are dB.

  • If the value of the HorizontalMagnitudePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the HorizontalMagnitudePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

If the directional pattern contains the value NaN in any direction along the azimuth and angle of the location, it is converted to Inf pointing to the zero directional pattern in that direction.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value true.

# HorizontalPhasePattern is the phase of the horizontal polarization component of the antenna radiation pattern

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The phase of the horizontal polarization component of the antenna radiation pattern, defined as a matrix on or an array on on .

The units of measurement of the phase are degrees.

  • If the value of the HorizontalPhasePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the HorizontalPhasePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

If the directional pattern contains the value NaN in any direction along the azimuth and angle of the location, it is converted to Inf pointing to the zero directional pattern in that direction.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value true.

# VerticalMagnitudePattern is the amplitude of the vertical polarization component of the antenna radiation pattern

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The amplitude of the vertical polarization component of the antenna radiation pattern, set as a matrix on or an array on on .

The units of amplitude measurement are dB.

  • If the value of the VerticalMagnitudePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the VerticalMagnitudePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

If the directional pattern contains the value NaN in any direction along the azimuth and angle of the location, it is converted to Inf pointing to the zero directional pattern in that direction.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value true.

# VerticalPhasePattern is the phase of the vertical polarization component of the radiation pattern of the antenna

+ zeros(181,361) (by default) | the real matrix Q on P | a real array of Q by P by L

Details

The phase of the vertical polarization component of the antenna radiation pattern, set as a matrix on or an array on on .

The units of measurement of the phase are degrees.

  • If the value of the VerticalPhasePattern property is a matrix on , the same radiation pattern applies to all frequencies specified in the FrequencyVector.

  • If the value of the VerticalPhasePattern property is an array on on , each matrix on The array defines a radiation pattern for the appropriate frequency specified in the FrequencyVector.

If the directional pattern contains the value NaN in any direction along the azimuth and angle of the location, it is converted to Inf pointing to the zero directional pattern in that direction.

System object EngeePhased.CustomAntennaElement uses interpolation to estimate the antenna pattern in a given direction. To avoid interpolation errors, the user’s directional pattern should contain azimuth angles in the range [−180,180] degrees, and the angles of the place are in the range [−90,90] degrees.

Dependencies

To use this property, set the SpecifyPolarizationPattern value true.

# MatchArrayNormal — matching the normal of the element to the normal of the antenna array

+ true (by default) | false

Details

Set the MatchArrayNormal property to true to align the antenna element to the normal of the antenna array. The antenna pattern rotates so that the axis The coordinate system of the element was directed along the normal of the antenna array. This property is used only if the antenna element belongs to the antenna array.

Set the MatchArrayNormal property to false to use the radiation pattern of an element without rotation.

Methods

Common to all system objects

step!

Running the system object operation algorithm

release!

Permission to change the value of a system object property

reset!

Resetting the internal states of a system object

Additional Info

Algorithms

Details

The radiation pattern of a custom antenna element is a combination of its frequency response and spatial response. This system object calculates both characteristics by interpolating the nearest neighbors, and then multiplies them to obtain a common diagram.