Engee documentation

Steering Vector

Antenna element control vector.

steering vector

Description

The Steering Vector block calculates the antenna element steering vector for specified directions and frequencies.

Ports

Input

# FREQ — antenna array operating frequency
scalar

Details

The operating frequency specified as a positive scalar.

The unit of measurement is Hz.

Dependencies

To use this port, set the Source of operating frequency parameters to Input port.

Data types

Float64.

Complex numbers support

No

# ANG — vector direction
vector | array

Details

Control vector directions given as a real vector of length or a real matrix 2 by , where is the number of control directions.

  • If ANG is matrix 2 at , then each column of the matrix specifies a direction in space in the form [azimuth; elevation]. The azimuth angle must be between -180° and 180°, and the elevation angle must 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

A control vector returned as a complex array to to or a structure containing arrays. Here is the number of antenna array elements, if the antenna array contains sub-arrays, then is the number of sub-arrays, is the number of control vector directions, 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 a signal as a real positive scalar.

By default, the speed of light is used.

The unit of measurement is m/c.

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 parameters is set to Input Port, the operating frequency is set via the Freq input port.

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

Values

Property | Input port

Default value

Input port

Program usage name

OperatingFrequencySource

Tunable

No

Evaluatable

No

# Operating frequency (Hz) — system operating frequency
Real number

Details

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

The unit of measurement is 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 check box to output the conjugate control vector. Otherwise, the control vector will not be conjugated.

Default value

false (switched off)

Program usage name

OutConj

Tunable

No

Evaluatable

No

# Number of bits in phase shifters — number of quantisation bits with phase shift
Real number

Details

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

Default value

0

Program usage name

NumberBitsPhaseShifters

Tunable

No

Evaluatable

Yes

Main

# Specify sensor array as — antenna array design method
Array (no subarrays)

Details

A method for specifying an 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 — antenna array element type
Isotropic Antenna | Cardioid Antenna | Cosine Antenna | Custom Antenna | Gaussian Antenna | Sinc Antenna | Omni Microphone | Custom Microphone

Details

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) — operating frequency range of the user antenna or acoustic element
Vector / matrix of real numbers

Details

The operating frequency range of the antenna or acoustic element as a string vector 1 at . Outside this frequency range, the element has no response.

The unit of frequency measurement is Hz.

Dependencies

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

Default value

[0, 1e20]

Program usage name

FrequencyVector

Tunable

No

Evaluatable

Yes

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

Details

Frequency response of the user antenna or user acoustic element for frequencies defined by the Operating frequency vector (Hz) parameters. The size of the Frequency responses (dB) vector must match the size of the vector defined by the Operating frequency vector (Hz) parameters.

Dependencies

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

Default value

[0, 0]

Program usage name

FrequencyResponse

Tunable

No

Evaluatable

Yes

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

Details

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

Dependencies

To use this parameter, set the Element type parameters 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

The azimuth angles from which the antenna radiation pattern will be calculated as a vector-line 1 to P. P must be greater than 2. The azimuth angles must lie in the range from −180° up to and including 180° and be 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) — antenna radiation pattern elevation angles
Vector / matrix of real numbers

Details

The elevation angles at which the radiation pattern should be calculated as vector 1 at . must be greater than 2. The units of angles are degrees. Elevation angles must lie in the range from −90° to 90° inclusive and be 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) — values of Phi angles of the antenna pattern
Vector / matrix of real numbers

Details

Angular coordinates Phi of the points at which the antenna radiation pattern is defined. Defined as a real vector-line 1 at . must be greater than 2. The units of measurement of the angles are degrees. The values of the angles Phi must lie in the range from 0° to 360° 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:360

Program usage name

PhiAngles

Tunable

No

Evaluatable

Yes

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

Details

Theta angular coordinates of the points where the antenna radiation pattern is defined. They are set as a real vector-string 1 at . must be greater than 2. The units of measurement of the angles are degrees. Values of the angles Theta must lie in the 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) — magnitude of the radiation pattern of the combined antenna
String

Details

The magnitude of the radiation pattern of the combined antenna, given as a matrix to or an array to to .

  • If the Input Pattern Coordinate System parameter is set to az-el, Q is equal to the length of the vector specified by the Elevation angles (deg) parameter, and P is equal to 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 is equal to the length of the vector specified by the Phi Angles (deg) parameter.

The value of is equal to the value of the Operating frequency vector (Hz) parameters.

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

  • If the parameter is an array to to , each page to of the array specifies the pattern for the corresponding frequency specified in the Operating frequency vector (Hz) parameter.

Dependencies

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

Default value

zeros(181,361)

Program usage name

MagnitudePattern

Tunable

No

Evaluatable

Yes

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

Details

Phase radiation pattern of a compound antenna, specified as a matrix to or an array to to .

  • 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 is equal to 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 is equal to the length of the vector specified by the Phi Angles (deg) parameter.

The value of is equal to the value of the Operating frequency vector (Hz) parameters.

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

  • If the parameter is an array to to , each page to of the array specifies the pattern for the corresponding frequency specified in the Operating frequency vector (Hz) parameter.

Dependencies

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

Default value

zeros(181,361)

Program usage name

PhasePattern

Tunable

No

Evaluatable

Yes

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

Details

If the parameters value is on, the antenna element pattern is rotated to align normal to the antenna array. If off, the element pattern is not rotated.

If the antenna is used in an antenna array and the Input Pattern Coordinate System parameters are set to az-el, selecting this checkbox rotates the directional pattern so that the x-axis of the element coordinate system points along the normal to the antenna array. If no selection is made, 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 parameters is set to phi-theta, checking this checkbox rotates the pattern so that the z-axis of the element coordinate system points along the normal to the antenna array.

Use this parameter in conjunction with the Array Normal parameters of the URA and UCA antenna arrays.

Dependencies

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

Default value

true (switched on)

Program usage name

AlignElementNormal

Tunable

No

Evaluatable

No

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

Details

The response frequencies of a polar pattern acoustic element, specified as a real scalar or a real string vector 1 at . The response frequencies lie within the frequency range specified by the parameter Operating frequency vector (Hz).

Dependencies

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

Default value

1e3

Program usage name

FrequencyPattern

Tunable

No

Evaluatable

Yes

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

Details

Set the polar response angles as vector 1 on . The angles are measured from the centre axis of the acoustic element and should range from −180° up to and including 180°.

Dependencies

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

Default value

-180:180

Program usage name

AnglePattern

Tunable

No

Evaluatable

Yes

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

Details

Set the polar pattern value of the custom acoustic element as a real vector string 1 at , where is the number of frequencies specified in the Polar pattern frequencies (Hz) parameters. The string represents the polar pattern magnitude measured at the corresponding frequency specified in Polar pattern frequencies (Hz). The directional pattern is measured in the azimuth plane. In the azimuth plane, the elevation angle is 0° and the centre axis is 0° in azimuth and 0° in elevation. The polar pattern is symmetrical around the centre axis. Based on the polar diagram, it is possible to construct the directivity diagram of an acoustic element in three-dimensional space.

Dependencies

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

Default value

zeros(1, 361)

Program usage name

PolarPattern

Tunable

No

Evaluatable

Yes

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

Details

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

The unit of frequency measurement is Hz.

Dependencies

To use this parameter, set the Element type parameters 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 directional pattern solution
Scalar / array of real numbers

Details

Angles of the directional pattern solution in degrees.

Dependencies

To use this parameter, set the Element type parameters 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-emission axis
String

Details

The direction of the zero emission axis.

Dependencies

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

Default value

-x

Program usage name

NullAxisDirection

Tunable

No

Evaluatable

Yes

# Exponent of cosine pattern — Setting the azimuthal and altitude cosine directional diagrams index
Scalar / array of real numbers

Details

Indices of the cosine directional diagram as a non-negative scalar or a real 1 by 2 matrix of non-negative values.

If the Exponent of cosine pattern is a 1 by 2 vector, the first element is the index in the azimuth direction and the second element is the index in the elevation direction. When this parameters is scalar, the cosines in the azimuth and elevation directions are raised to the same degree.

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 check box to mute the response of the element.

Silencing the response at all azimuth angles greater than ±90° from the broadside sets the responses to zero. The broadside is defined as an azimuth angle of 0° and an elevation angle of 0°.

Dependencies

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

Default value

false (switched off)

Program usage name

BaffleBackElement

Tunable

No

Evaluatable

No

Array

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

Details

The geometry of the antenna array, given as:

  • ULA is a uniform linear antenna array.

  • URA - uniform rectangular antenna array.

  • UCA - 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 antenna array elements ULA or UCA
Real number

Details

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

Dependencies

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

Default value

Program usage name

NumberElementsULA, NumberElementsUCA

Tunable

No

Evaluatable

Yes

# Radius of UCA (m) — 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 — dimensions of the URA antenna array
Scalar / array of real numbers

Details

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

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

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

For URA, the elements of the antenna array are indexed from top to bottom by the leftmost column and then proceed to the next columns from left to right. The figure shows an antenna array for which the Array size parameters is [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) — distance between antenna array elements
Scalar / array of real numbers

Details

The distance between neighbouring elements of ULA or URA arrays as a positive scalar.

Dependencies

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

Default value

Program usage name

ElementSpacingULA, ElementSpacingURA

Tunable

No

Evaluatable

Yes

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

Details

The direction of the linear axis of the ULA, given as y, x or z. All elements of the ULA antenna array are uniformly distributed along this axis in the local array 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

Lattice of URA element positions defined as rectangular or triangular.

  • Rectangular - aligns all elements by rows and columns.

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

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 — direction of the antenna array normal URA or UCA
x | y | z

Details

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

The elements of plane gratings 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 normal direction of the antenna array.

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

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

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

Dependencies

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

Values

x | y | z

Default value

Program usage name

ArrayNormalURA, ArrayNormalUCA

Tunable

No

Evaluatable

No

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

Details

The positions of the conformal antenna array elements given as a matrix of real values 3 by , where is the number of elements in the conformal array. Each column of this matrix represents the position [x;y;z] of the antenna array element 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 parameters to Conformal Array.

Default value

[0, 0, 0]

Program usage name

ElementPositions

Tunable

No

Evaluatable

Yes

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

Details

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

The parameters 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 may include translation, azimuth rotation, and elevation rotation. However, you cannot use transformations that require rotation with respect to the direction of the normal.

Dependencies

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

Default value

[0, 0]

Program usage name

ElementNormals

Tunable

No

Evaluatable

Yes

# Taper — change of the directivity diagram of the antenna array elements
Scalar / array of real and/or complex numbers

Details

The change of the directivity diagram of the antenna array elements is specified as a complex scalar or complex vector 1 at , where is the number of antenna array elements.

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

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

Default value

1

Program usage name

Taper

Tunable

No

Evaluatable

Yes