Engee documentation

Steering Vector

The control vector of antenna elements.

blockType: SteeringVector

Path in the library:

/Phased Array Systems/Transmitters and Receivers/Steering Vector

Description

Block Steering Vector calculates the control vector of the antenna elements for the specified directions and frequencies.

Ports

Input

# FREQ — antenna array operating frequency
scalar

Details

The operating frequency, set as a positive scalar.

The units of measurement are Hz.

Dependencies

To use this port, set the Source of operating frequency parameter to `Input port'.

Data types

Float64

Complex numbers support

No

# ANG — vector direction
vector | array

Details

The directions of the control vector, defined as a real vector of length or the real matrix 2 on , where – this is the number of management directions.

  • If ANG is a 2 matrix on , then each column of the matrix defines a direction in space in the form of [azimuth; elevation]. The azimuth angle should be between -180° and 180°, and the elevation angle should be between -90° and 90°.

  • If ANG is a vector of length its values correspond to the azimuth angles of the rudder direction vector, and the elevation angles are set to zero.

The units of measurement are degrees.

Data types

Float64

Complex numbers support

No

Output

# SV — control vector
array

Details

The control vector returned as a complex array on on or a structure containing arrays. Here is the number of antenna array elements, if the antenna array contains sublattices, then – this is the number of sublattices, – this is the number of directions of the control vector, – this is the number of operating frequencies.

Data types

Float64

Complex numbers support

Yes

Parameters

Main

# Signal propagation speed (m/s) — signal propagation speed
Real number

Details

The propagation velocity of the signal in the form of a real positive scalar.

The default value is the speed of light.

The units of measurement are m/s.

Default value

299792458

Program usage name

PropagationSpeed

Tunable

No

Evaluatable

Yes

# Source of operating frequency — operating frequency source
Property | Input port

Details

Operating frequency source: Input Port or Property.

If the parameter is set to Input Port, the operating frequency is set via the input port `Freq'.

If the parameter is set to Property, the operating frequency is set using the Operating frequency (Hz) parameter.

Values

Property | Input port

Default value

Input port

Program usage name

OperatingFrequencySource

Tunable

No

Evaluatable

No

# Operating frequency (Hz) — Operating frequency of the system
Real number

Details

The operating frequency of the system, set as a positive scalar.

The units of measurement are Hz.

Default value

3e8

Program usage name

OperatingFrequency

Tunable

No

Evaluatable

Yes

# Output conjugated steering vector — output of the conjugate control vector
Logical

Details

Select this checkbox to display the conjugate control vector. Otherwise, the control vector will not be conjugate.

Default value

false (switched off)

Program usage name

OutConj

Tunable

No

Evaluatable

No

# Number of bits in phase shifters — number of phase shift quantization bits
Real number

Details

The number of bits used to quantize the phase shift component of the beamforming vector or control vector weights. Specify the number of bits as a non-negative integer. A value of zero means that quantization is not performed.

Default value

0

Program usage name

NumberBitsPhaseShifters

Tunable

No

Evaluatable

Yes

Main

# Specify sensor array as — the method of setting the antenna array
Array (no subarrays)

Details

The method of setting the antenna array.

Available values:

  • Array (no subarrays)

Values

Array (no subarrays)

Default value

Array (no subarrays)

Program usage name

SpecifySensorArray

Tunable

No

Evaluatable

No

Element

# Element type — type of antenna array element
Isotropic Antenna | Cardioid Antenna | Cosine Antenna | Custom Antenna | Gaussian Antenna | Sinc Antenna | Omni Microphone | Custom Microphone

Details

The type of antenna or acoustic element.

Available values:

  • Isotropic Antenna

  • Cardioid Antenna

  • Cosine Antenna

  • Custom Antenna

  • Gaussian Antenna

  • Sinc Antenna

  • Omni Microphone

  • Custom Microphone

Values

Isotropic Antenna | Cardioid Antenna | Cosine Antenna | Custom Antenna | Gaussian Antenna | Sinc Antenna | Omni Microphone | Custom Microphone

Default value

Isotropic Antenna

Program usage name

ElementType

Tunable

No

Evaluatable

No

# Operating frequency vector (Hz) — the operating frequency range of a custom antenna or acoustic element
Vector / matrix of real numbers

Details

The range of operating frequencies of the antenna or acoustic element in the form of a vector row 1 on . Outside of this frequency range, the element has no response.

The units of frequency measurement are Hz.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna or `Custom Microphone'. Use the Frequency responses (dB) parameter to adjust the responses at these frequencies.

Default value

[0, 1e20]

Program usage name

FrequencyVector

Tunable

No

Evaluatable

Yes

# Frequency responses (dB) — frequency response of the antenna and acoustic element
Vector / matrix of real numbers

Details

The frequency response of a custom antenna or custom acoustic element for frequencies defined by the Operating frequency vector (Hz) parameter. The dimensions of the Frequency responses (dB) vector must match the dimensions of the vector specified by the Operating frequency vector (Hz) parameter.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna or `Custom Microphone'.

Default value

[0, 0]

Program usage name

FrequencyResponse

Tunable

No

Evaluatable

Yes

# Input pattern coordinate system — the coordinate system of the directional pattern of the user antenna
az-el | phi-theta

Details

The coordinate system of the radiation pattern of the user antenna is indicated by az-el or phi-theta'. When specifying `az-el, the Azimuth angles (deg) and Elevations angles (deg) parameters are used to set the coordinates of the points of the directional pattern. When specifying the phi-theta parameter, the Phi angles (deg) and Theta angles (deg) parameters are used to set the coordinates of the points in the radiation pattern.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna.

Values

az-el | phi-theta

Default value

az-el

Program usage name

CoordinateSystem

Tunable

No

Evaluatable

No

# Azimuth angles (deg) — azimuth angles of the antenna radiation pattern
Vector / matrix of real numbers

Details

Azimuth angles, which will be used to calculate the radiation pattern of the antenna in the form of a vector row 1 on P. P must be greater than 2. The azimuth angles must be in the range of −180° up to 180° inclusive and arranged in strictly ascending order.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna and the Input Pattern Coordinate System parameter to az-el.

Default value

-180:180

Program usage name

AzimuthAngle

Tunable

No

Evaluatable

Yes

# Elevation angles (deg) — elevation angles of the antenna radiation pattern
Vector / matrix of real numbers

Details

Elevation angles at which it is necessary to calculate the radiation pattern in the form of a vector 1 on . it must be more than 2. The units of measurement of angles are degrees. Elevation angles should be in the range of −90° to 90° inclusive and arranged in strictly ascending order.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna and the Input Pattern Coordinate System parameter to az-el.

Default value

-90:90

Program usage name

ElevationAngle_R

Tunable

No

Evaluatable

Yes

# Phi angles (deg) — the values of the Phi angles of the antenna pattern
Vector / matrix of real numbers

Details

The angular coordinates of the Phi points where the antenna radiation pattern is set. They are defined as a real vector-row 1 on . it must be more than 2. The units of measurement of angles are degrees. The values of the Phi angles should be in the range from 0° to 360° and arranged in strictly ascending order.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna and the Input Pattern Coordinate System parameter to phi-theta.

Default value

0:360

Program usage name

PhiAngles

Tunable

No

Evaluatable

Yes

# Theta angles (deg) — the values of the angles of the Theta radiation pattern of the antenna
Vector / matrix of real numbers

Details

The angular coordinates of the Theta points where the antenna radiation pattern is set. They are defined as a real vector-lines 1 on . it must be more than 2. The units of measurement of angles are degrees. The values of the Theta angles must range from 0° to 180° and be arranged in strictly ascending order.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna and the Input Pattern Coordinate System parameter to phi-theta.

Default value

0:180

Program usage name

ThetaAngles

Tunable

No

Evaluatable

Yes

# Magnitude pattern (dB) — the magnitude of the radiation pattern of the combined antenna
String

Details

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

  • If the Input Pattern Coordinate System parameter is set to az-el, then Q is equal to the length of the vector specified by the Elevation angles (deg) parameter, and P is the length of the vector specified by the Azimuth angles (deg) parameter.

  • If the Input Pattern Coordinate System parameter is set to `phi-theta', then is equal to the length of the vector specified by the Theta Angles (deg) parameter, and — the length of the vector specified by the Phi Angles (deg) parameter.

Value is equal to the value of the Operating frequency vector (Hz) parameter.

  • If the value of this parameter is a matrix on , then the same scheme is applied for all frequencies specified in the parameter Operating frequency vector (Hz).

  • If the parameter is an array on on , then each page on The array sets the radiation pattern for the corresponding frequency specified in the parameter Operating frequency vector (Hz).

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna.

Default value

zeros(181,361)

Program usage name

MagnitudePattern

Tunable

No

Evaluatable

Yes

# Phase pattern (deg) — user antenna radiation phase diagram
String

Details

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

  • If the Input Pattern Coordinate System parameter is set to `az-el', then is equal to the length of the vector specified by the Elevation angles (deg) parameter, and — the length of the vector specified by the Azimuth angles (deg) parameter.

  • If the Input Pattern Coordinate System parameter is set to `phi-theta', then is equal to the length of the vector specified by the Theta Angles (deg) parameter, and — the length of the vector specified by the Phi Angles (deg) parameter.

Value is equal to the value of the Operating frequency vector (Hz) parameter.

  • If the value of this parameter is a matrix on , then the same scheme is applied for all frequencies specified in the parameter Operating frequency vector (Hz).

  • If the parameter is an array on on , then each page on The array sets the radiation pattern for the corresponding frequency specified in the parameter Operating frequency vector (Hz).

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna.

Default value

zeros(181,361)

Program usage name

PhasePattern

Tunable

No

Evaluatable

Yes

# Align element normal with array normal — rotating the antenna element to the normal position of the antenna array
Logical

Details

If the value of the parameter is enabled, then the radiation pattern of the antenna element rotates to align with the normal to the antenna array. If it is off, then the radiation pattern of the element does not rotate.

If the antenna is used in an antenna array and the Input Pattern Coordinate System parameter has the value az-el, checking this box rotates the radiation pattern so that the x-axis of the element’s coordinate system points along the normal to the antenna array. If there is no choice, the directional pattern of the element without rotation is used.

If the antenna is used in an antenna array and the Input Pattern Coordinate System parameter is set to phi-theta, checking this box rotates the radiation pattern so that the z axis of the element’s coordinate system points along the normal to the antenna array.

Use this parameter together with the Array Normal parameter. URA and UCA antenna arrays.

Dependencies

To use this parameter, set the Element type parameter to Custom Antenna.

Default value

true (switched on)

Program usage name

AlignElementNormal

Tunable

No

Evaluatable

No

# Polar pattern frequencies (Hz) — response frequencies of an acoustic element with a polar pattern
Real number

Details

The response frequencies of an acoustic element with a polar radiation pattern, specified as a real scalar or a real vector, are lines 1 on . The response frequencies are in the frequency range specified by the parameter Operating frequency vector (Hz).

Dependencies

To use this parameter, set the Element type parameter to Custom Microphone.

Default value

1e3

Program usage name

FrequencyPattern

Tunable

No

Evaluatable

Yes

# Polar pattern angles (deg) — response angles of the polar radiation pattern
Vector / matrix of real numbers

Details

Set the response angles of the polar radiation pattern as a vector 1 to . The angles are measured from the central axis of the acoustic element and should be in the range of −180° to 180° inclusive.

Dependencies

To use this parameter, set the Element type parameter to Custom Microphone.

Default value

-180:180

Program usage name

AnglePattern

Tunable

No

Evaluatable

Yes

# Polar pattern (dB) — polar radiation pattern of a custom acoustic element
Vector / matrix of real numbers

Details

Set the value of the polar radiation pattern of the user acoustic element in the form of a real vector-row 1 on , where — the number of frequencies specified in the parameter Polar pattern frequencies (Hz). The string represents the value of the polar radiation pattern measured at the corresponding frequency specified in the Polar pattern frequencies (Hz). The radiation pattern is measured in the azimuthal plane. In the azimuthal plane, the elevation angle is 0°, and the central axis is 0° in azimuth and 0° in elevation. The polar radiation pattern is symmetrical around the central axis. Based on the polar diagram, it is possible to construct a directional diagram of an acoustic element in three-dimensional space.

Dependencies

To use this parameter, set the Element type parameter to Custom Microphone.

Default value

zeros(1, 361)

Program usage name

PolarPattern

Tunable

No

Evaluatable

Yes

# Operating frequency range (Hz) — the range of operating frequencies of the antenna or acoustic element
Array of real numbers

Details

The range of operating frequencies of an antenna or acoustic element in the form of a 1-by-2 row vector in the form of `[LowerBound,UpperBound]'. Outside of this frequency range, the element has no response.

The units of frequency measurement are Hz.

Dependencies

To use this parameter, set the Element type parameter to Isotropic Antenna, Cosine Antenna, or 'Omni Microphone'.

Default value

[0 1e20]

Program usage name

OperatingFrequencyRange

Tunable

No

Evaluatable

Yes

# Radiation pattern beamwidth (deg) — angles of the radiation pattern solution
Scalar / array of real numbers

Details

The angles of the radiation pattern solution in degrees.

Dependencies

To use this parameter, set the Element type parameter to Gaussian Antenna or `Sinc Antenna'.

Default value

[10, 10]

Program usage name

RadiationPatternBeamwidth

Tunable

No

Evaluatable

Yes

# Null axis direction — direction of the zero radiation axis
String

Details

The direction of the zero radiation axis.

Dependencies

To use this parameter, set the Element type parameter to Cardioid Antenna.

Default value

-x

Program usage name

NullAxisDirection

Tunable

No

Evaluatable

Yes

# Exponent of cosine pattern — setting the azimuthal and altitude cosine radiation patterns indicator
Scalar / array of real numbers

Details

The exponents of the cosine radiation pattern are in the form of a non-negative scalar or a 1 by 2 real matrix of non-negative values.

If the Exponent of cosine pattern is a 1 by 2 vector, then the first element is an indicator in the azimuth direction, and the second is in the elevation direction. With a scalar value of this parameter, the cosines in the azimuthal and elevation directions are raised to one power.

Dependencies

To use this parameter, set the Element type parameter to `Cosine Antenna'.

Default value

[1.5 1.5]

Program usage name

ExponentCosinePattern

Tunable

No

Evaluatable

Yes

# Baffle the back of the element — set the response of the Isotropic Antenna element or Omni Microphone' to zero
`Logical

Details

Select this option to mute the response of the element.

When the response is suppressed at all azimuth angles exceeding ± 90° from the wide side, the responses are set to zero. The wide side is defined as the azimuth angle of 0° and the elevation angle of 0°.

Dependencies

To use this parameter, set the Element type parameter to Isotropic Antenna or `Omni Microphone'.

Default value

false (switched off)

Program usage name

BaffleBackElement

Tunable

No

Evaluatable

No

Array

# Geometry — geometry of the antenna array
ULA | URA | UCA | Conformal array

Details

The geometry of the antenna array, defined as:

  • 'ULA' is a uniform linear antenna array.

  • URA is a uniform rectangular antenna array.

  • 'UCA` is a uniform circular antenna array.

  • `Conformal Array' — arbitrary arrangement of elements.

Values

ULA | URA | UCA | Conformal array

Default value

ULA

Program usage name

Geometry

Tunable

No

Evaluatable

No

# Number of elements — number of elements of the ULA or UCA antenna array
Real number

Details

The number of antenna array elements for ULA or UCA, set as an integer greater than or equal to 2.

Dependencies

To use this parameter, set the Geometry parameter to ULA or `UCA'.

Default value

Program usage name

NumberElementsULA, NumberElementsUCA

Tunable

No

Evaluatable

Yes

# Radius of UCA (m) — the radius of the UCA antenna array
Real number

Details

The radius of the UCA antenna array, a positive scalar.

Dependencies

To use this parameter, set the Geometry parameter to UCA.

Default value

0.5

Program usage name

RadiusUCA

Tunable

No

Evaluatable

Yes

# Array size — URA antenna array dimensions
Scalar / array of real numbers

Details

The dimensions of the URA antenna array, specified as a positive integer or a vector of positive integers 1 by 2.

  • If the size of the antenna array is a 1 by 2 vector, then the vector has the form [NumberOfArrayRows, NumberOfArrayColumns].

  • If the size of the antenna array is an integer, then the array has the same number of rows and columns.

For URA, the antenna array elements are indexed from top to bottom in the leftmost column, and then move to the next columns from left to right. The figure shows an antenna array for which the Array size parameter has the value [3,2], that is, it has three rows and two columns.

mvdr beamformer 1

Dependencies

To use this parameter, set the Geometry parameter to `URA'.

Default value

[2 2]

Program usage name

ArraySize

Tunable

No

Evaluatable

Yes

# Element spacing (m) — the distance between the elements of the antenna array
Scalar / array of real numbers

Details

The distance between adjacent elements of the ULA or URA lattices in the form of a positive scalar.

Dependencies

To use this parameter, set the Geometry parameter to ULA or `URA'.

Default value

Program usage name

ElementSpacingULA, ElementSpacingURA

Tunable

No

Evaluatable

Yes

# Array axis — direction of the ULA linear axis
x | y | z

Details

The direction of the ULA linear axis, set as y, x or z. All elements of the ULA antenna array are evenly distributed along this axis in the local grid coordinate system.

Dependencies

To use this parameter, set the Geometry parameter to ULA.

Values

x | y | z

Default value

y

Program usage name

ArrayAxis

Tunable

No

Evaluatable

No

# Element lattice — grid of URA element positions
Rectangular | Triangular

Details

A grid of URA element positions, defined as rectangular or triangular.

  • 'Rectangular' — aligns all elements in rows and columns.

  • Triangular — shifts the elements of an even row of a rectangular grid towards the positive direction of the row axis. The offset is half the distance between the elements along the dimension of the row.

Dependencies

To use this parameter, set the Geometry parameter to `URA'.

Values

Rectangular | Triangular

Default value

Rectangular

Program usage name

ElementLattice

Tunable

No

Evaluatable

No

# Array normal — URA or UCA antenna array normal direction
x | y | z

Details

The direction of the antenna array normal, set as x, y, or z.

The elements of the flat arrays lie in a plane orthogonal to the selected direction of the antenna array normal. The directions of the angular coordinates of the elements are directed along the direction of the antenna array normal.

  • The 'x` elements of the antenna array lie in the yz plane. The angular coordinate vectors of all elements are directed along the x-axis.

  • The 'y` elements of the antenna array lie in the zx plane. The angular coordinate vectors of all elements are directed along the y axis.

  • The 'z` elements of the antenna array lie in the xy plane. The angular coordinate vectors of all elements are directed along the z axis.

Dependencies

To use this parameter, set the Geometry parameter to URA or `UCA'.

Values

x | y | z

Default value

Program usage name

ArrayNormalURA, ArrayNormalUCA

Tunable

No

Evaluatable

No

# Element positions (m) — positions of the elements of the conformal antenna array
Array of real numbers

Details

The positions of the elements of the conformal antenna array, given as a matrix of real values 3 on , where — the number of elements in the conformal lattice. Each column of this matrix represents the position [x;y;z] of an element of the antenna array in the local coordinate system of the antenna array. The origin of the local coordinate system is (0,0,0).

The units of measurement are m.

Dependencies

To use this parameter, set the Geometry parameter to `Conformal Array'.

Default value

[0, 0, 0]

Program usage name

ElementPositions

Tunable

No

Evaluatable

Yes

# Element normals (deg) — the direction of the normal vectors of the elements of the conformal antenna array
Array of real numbers

Details

The direction of the normal vectors of the elements of the conformal antenna array, defined as a 2-by-1 column vector or a 2-by-1 matrix , where indicates the number of elements in the antenna array. For the matrix, each column specifies the direction of the normal of the corresponding element in the form of [azimuth;elevation] relative to the local coordinate system. In the local coordinate system, the positive axis is coincides with the direction of the normal to the conformal antenna array. If the parameter value is a 2-by-1 column vector, then the same pointing direction is used for all elements of the antenna array.

Parameters of Element positions (m) and Element normals (deg) can be used to represent any arrangement in which pairs of elements differ from each other by certain transformations. These transformations can include translation, azimuth rotation, and elevation rotation. However, transformations that require rotation relative to the normal direction cannot be used.

Dependencies

To use this parameter, set the Geometry parameter to `Conformal Array'.

Default value

[0, 0]

Program usage name

ElementNormals

Tunable

No

Evaluatable

Yes

# Taper — changing the radiation pattern of antenna array elements
Scalar / array of real and/or complex numbers

Details

The change in the radiation pattern of the antenna array elements is set as a complex scalar or a complex vector 1 by , where — the number of antenna array elements.

The coefficients that change the radiation pattern, also called element weights, multiply the responses of the antenna array elements. The coefficients change both the amplitude and the phase of the response to reduce the side lobes or the direction of the main axis of the response.

If the value of the Taper parameter is a scalar, then the same weight is applied to each element. If Taper is a vector, then a weight from the vector is applied to the corresponding element of the antenna array. The number of scales must correspond to the number of antenna array elements.

Default value

1

Program usage name

Taper

Tunable

No

Evaluatable

Yes