Subband MVDR Beamformer

The input signal given as a matrix by , where is the number of samples of the signal and is the number of antenna elements of the array.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64

Support for complex numbers: Yes

Reference signal given as a matrix by , where is the number of signal samples and is the number of signals.

Dependencies

To enable this port, select the Enable training data input checkbox.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool.

Support for complex numbers: Yes

Signal emission directions given as a real matrix 2 by , where is the number of beam forming directions. Each column specifies a radiation direction in the form of [AzimuthAngle;ElevationAngle]. The azimuth angle must lie in the range from -180° to 180° inclusive. The elevation angle shall lie in the range of -90° to 90° inclusive. The angles are specified relative to the local coordinate system of the array.

Dependencies

To use this port, set the Source of beamforming direction parameters to `Input port'.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

The output signal returned as a complex matrix to , where is the number of samples of the signal and is the number of desired beamforming directions set by the Beamforming direction parameters or from the Ang port.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Support for complex numbers: Yes

Sub-band centre frequencies returned as a vector-column with real values by 1, where is the number of sub-bands specified in the Number of sub-bands parameters.

Dependencies

To use this port, select the Enable subband centre frequencies output checkbox.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Beamforming weights returned as a complex matrix by , where is the number of array elements. If the Specify sensor array as parameters are set to Partitioned array or Replicated subarray, then is the number of subarrays. - the number of desired beamforming directions specified in the Ang port or by the Beamforming direction (deg) parameters. There is one set of weights for each beamforming direction.

Dependencies

To use this port, select the Enable weights output checkbox.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Support for complex numbers: Yes

Signal propagation speed as a real positive scalar. By default, the value of the speed of light is 3e8 m/c.

The unit of measurement is metres per second.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

The operating frequency of the system specified as a positive scalar. The unit of measurement is hertz.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Select this parameter to inherit the sample rate from upstream blocks. Otherwise, specify the sampling frequency using the Sample rate (Hz) parameters.

Data types: Bool.

The sampling frequency of the signal specified as a positive scalar. The unit of measurement is hertz.

Dependencies

To use this parameters, uncheck Inherit sample rate.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

The number of subbands to be processed, specified as a positive integer.

Data types: Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Source of beamforming direction, set as Property or Input port.

Beamforming directions given as a real matrix 2 by , where is the number of beamforming directions. Each column is of the form [AzimuthAngle;ElevationAngle]. The units of the angle are degrees. The azimuth angle must lie in the range from −180° to 180°. Elevation angle must lie in the range from −90° to 90°. Angles are specified relative to the local coordinate system of the array.

Dependencies

To use this parameter, set the Source of beamforming direction parameter to Property.

Select this checkbox to get beamformer weights from the W output port.

Select this checkbox to receive the centre frequencies of each sub-band through the Freq output port.

Array assignment method, available values:

Type of antenna or microphone.

Available values:

The operating frequency range of the antenna or microphone 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.

Select this check box to silence the echo of the element.

When diverted back, the echoes at all azimuth angles greater than ±90° from the broadside are set 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.

Zero radiation axis direction.

Dependencies

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

The exponents of cosine model as 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, the first element is the exponent in the azimuth direction and the second in the elevation direction. When this parameters is scalar, the cosines in the azimuth and elevation directions are raised to one degree.

Dependencies

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

The operating frequency range of the antenna or microphone as a vector-string 1 at of increasing real values. An element has no response outside the frequency range given by the minimum and maximum elements of this vector. 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) parameter to set the response at these frequencies.

Frequency response of the user antenna or user microphone for frequencies defined by the Operating frequency vector (Hz) parameters. The dimensions of the Frequency responses (dB) vector must match the dimensions 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.

Coordinate system of the user antenna pattern, 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 angle (deg) and Theta angles (deg) parameters are used to specify the coordinates of the pattern points.

Dependencies

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

The azimuth angles from which the antenna radiation pattern will be calculated as a vector-string 1 to P. P must be greater than 2. The azimuth angles must lie in the range from −180° to 180° inclusive, and must 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.

The elevation angles at which you want to calculate the radiation pattern as vector 1 at . must be greater than 2. The units of measurement of the 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.

Angular coordinates Phi of the points where the antenna radiation pattern is specified. Defined as a real vector-string 1 on . must be greater than 2. The units of angles are degrees. The angles Phi must lie in the range from 0° to 360° and be arranged in a strictly increasing order.

Dependencies

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

Theta angular coordinates of the points at which the antenna radiation pattern is specified. Defined as a real vector-string 1 on . must be greater than 2. The units of angles are degrees. Theta angles must lie in the range from 0° to 180° and be arranged in strictly increasing order.

Dependencies

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

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

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

Dependencies

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

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

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

Dependencies

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

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

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

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

Dependencies

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

Angles of the beamwidth pattern solution in degrees.

Dependencies

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

The response frequencies of a polar pattern microphone, given as a real scalar or real vector-string 1 on . The response frequencies lie within the frequency range specified by the Operating frequency vector (Hz) parameters.

Dependencies

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

Set the response angles of the polar radiation pattern as vector-string 1 at . The angles are measured from the centre axis of the microphone and should range from −180° to 180° inclusive.

Dependencies

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

Set the polar pattern magnitude of the custom microphone element as a real vector-string 1 by , 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 pattern, you can construct the microphone’s radiation pattern in three-dimensional space.

Dependencies

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

The geometry of the array, specified as:

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

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

Dependencies

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

URA array sizes specified as a positive integer or a vector of positive integers 1 by 2.

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

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

Dependencies

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

The distance between neighbouring elements of an array:

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

Dependencies

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

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

Dependencies

Lattice of URA element positions specified as rectangular or triangular.

Dependencies

Array normal direction specified as x, y or z.

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

Dependencies

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

Radius of UCA array, positive scalar.

Dependencies

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

The positions of the elements of a conformal array given as a 3-by real-value matrix, where is the number of elements in the conformal array. Each column of this matrix represents the position [x;y;z] of an array element in the array’s local coordinate system. The origin of the local coordinate system is (0,0,0). The units of measurement are metres.

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

Dependencies

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

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

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

The Element positions (m) and Element normals (deg) parameters 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.

The taper of an element, given as a complex scalar or complex vector 1 at . In this vector, is the number of elements in the array.

The tapering coefficients, also called element weights, multiply the responses of the array elements. Cones 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 sensor element. The number of weights must correspond to the number of array elements.

When the Specify sensor array as parameter is set to Replicated subarray, this parameter is applied to each subarray.

Set the subarray selection as a matrix to , where is the number of subarrays, is the total number of elements in the array. Each row of the matrix represents a subarray, and each entry in the row indicates whether the element belongs to that subarray. If the entry is zero, the element does not belong to the subarray. A non-zero entry represents the complex weight applied to the corresponding element. Each row must contain at least one non-zero entry.

The phase centre of each subarray is at the geometric centre of the subarray. The geometric centre of a subarray depends on the subarray definition matrix and Geometry parameters.

Dependencies

To use this parameter, set the Specify sensor array as parameters to Partitioned Array.

Subarray steering method specified as:

Dependencies

To use this parameter, set the Specify sensor array as parameters to Partitioned Array or Replicated subarray.

The operating frequency of the subarray phase shift, specified as a positive real scalar. The unit of measurement is Hz.

Dependencies

To use this parameter, set the Sensor array parameters to Partitioned array or Replicated subarray and set the Subarray steering method parameters to Phase.

Subarray phase shift quantisation bits, specified as a non-negative integer. A value equal to zero means that quantisation is not performed.

Dependencies

To use this parameter, set the Sensor array parameter to Partitioned array or Replicated subarray and set the Subarray steering method parameter to Phase.

Specify the layout of replicated subarrays.

When Rectangular is set, Grid size and Grid spacing parameters are used for subarray placement.

When Custom is set, the Subarray positions (m) and Subarray normals parameters are used for subarray placement.

Dependencies

To use this parameter, set the Sensor array parameters to Replicated subarray.

Rectangular subarray grid size specified as a single positive integer or a vector-string of positive integers 1 by 2.

Dependencies

To use this parameter, set the Sensor array parameter to Replicated subarray and the Subarrays layout parameter to Rectangular.

The distance between subarrays in a rectangular grid, given as a positive real scalar or vector 1 by 2 or Auto. The units of measure are metres.

If Grid spacing is a scalar, the row and column spacing is the same.

If Grid spacing is a 1 by 2 row vector, the vector is of the form [SpacingBetweenRows,SpacingBetweenColumn], the first variable specifies the row spacing along the column. The second variable is the spacing between columns along the row.

If the Grid spacing parameters are set to Auto, replication preserves the spacing between subarray elements for both rows and columns when building a full array. This option is available only if ULA or URA is selected for the Geometry parameters.

Dependencies

To use this option, set the Sensor array parameters to Replicated subarray and the Subarrays layout parameters to Rectangular.

The positions of the subarrays in the custom grid, given as a real matrix 3 by , where is the number of subarrays in the array. Each column of the matrix represents the position of one subarray in the local coordinate system of the array. Coordinates are expressed as [x; y; z]. The units of measurement are metres.

Dependencies

To use this parameter, set the Sensor array parameter to Replicated subarray and the Subarrays layout parameter to Custom.

The direction of the array subarray normals. The value of this parameter is a matrix of size 2 by , where is the number of subarrays in the array. Each column of the matrix specifies the normal direction of the corresponding subarray in the form [azimuth;elevation]. The units of angles are degrees. Angles are defined relative to the local coordinate system.

The Subarray positions and Subarray normals parameters can be used to represent any arrangement in which pairs of subarrays are distinguished by certain transformations. These transformations may include translation, azimuth rotation, and elevation rotation. However, you cannot use transformations that require rotation with respect to a normal.

Dependencies

To use this parameter, set the Sensor array parameter to Replicated subarray and the Subarrays layout parameter to Custom.