**System object: **phased.PartitionedArray

**Package: **phased

Directivity of partitioned array

`D = directivity(H,FREQ,ANGLE)`

D = directivity(H,FREQ,ANGLE,Name,Value)

`D = directivity(`

returns
the Directivity of a partitioned
array of antenna or microphone elements, `H`

,`FREQ`

,`ANGLE`

)`H`

, at
frequencies specified by `FREQ`

and in angles of
direction specified by `ANGLE`

.

`D = directivity(`

returns
the directivity with additional options specified by one or more `H`

,`FREQ`

,`ANGLE`

,`Name,Value`

)`Name,Value`

pair
arguments.

`H`

— Partitioned arraySystem object™

Partitioned array, specified as a `phased.PartitionedArray`

System
object.

**Example: **`H = phased.PartitionedArray;`

`FREQ`

— Frequency for computing directivity and patternspositive scalar | 1-by-

Frequencies for computing directivity and patterns, specified
as a positive scalar or 1-by-*L* real-valued row
vector. Frequency units are in hertz.

For an antenna, microphone, or sonar hydrophone or projector element,

`FREQ`

must lie within the range of values specified by the`FrequencyRange`

or`FrequencyVector`

property of the element. Otherwise, the element produces no response and the directivity is returned as`–Inf`

. Most elements use the`FrequencyRange`

property except for`phased.CustomAntennaElement`

and`phased.CustomMicrophoneElement`

, which use the`FrequencyVector`

property.For an array of elements,

`FREQ`

must lie within the frequency range of the elements that make up the array. Otherwise, the array produces no response and the directivity is returned as`–Inf`

.

**Example: **`[1e8 2e6]`

**Data Types: **`double`

`ANGLE`

— Angles for computing directivity1-by-

Angles for computing directivity, specified as a 1-by-*M* real-valued
row vector or a 2-by-*M* real-valued matrix, where *M* is
the number of angular directions. Angle units are in degrees. If `ANGLE`

is
a 2-by-*M* matrix, then each column specifies a direction
in azimuth and elevation, `[az;el]`

. The azimuth
angle must lie between –180° and 180°. The elevation
angle must lie between –90° and 90°.

If `ANGLE`

is a 1-by-*M* vector,
then each entry represents an azimuth angle, with the elevation angle
assumed to be zero.

The azimuth angle is the angle between the *x*-axis and the projection of the
direction vector onto the *xy* plane. This angle is positive when
measured from the *x*-axis toward the *y*-axis. The
elevation angle is the angle between the direction vector and *xy*
plane. This angle is positive when measured towards the *z*-axis. See
Azimuth and Elevation Angles.

**Example: **`[45 60; 0 10]`

**Data Types: **`double`

Specify optional
comma-separated pairs of `Name,Value`

arguments. `Name`

is
the argument name and `Value`

is the corresponding value.
`Name`

must appear inside quotes. You can specify several name and value
pair arguments in any order as
`Name1,Value1,...,NameN,ValueN`

.

`'PropagationSpeed'`

— Signal propagation speedspeed of light (default) | positive scalar

Signal propagation speed, specified as the comma-separated pair
consisting of `'PropagationSpeed'`

and a positive
scalar in meters per second.

**Example: **`'PropagationSpeed',physconst('LightSpeed')`

**Data Types: **`double`

`'Weights'`

— Subarray weights1 (default) |

Subarray weights, specified as the comma-separated pair consisting
of `'Weights`

' and an *N*-by-1 complex-valued
column vector or *N*-by-*M* complex-valued
matrix. The dimension *N* is the number of subarrays
in the array. The dimension *L* is the number of
frequencies specified by the `FREQ`

argument.

`Weights` dimension | `FREQ` dimension | Purpose |
---|---|---|

N-by-1 complex-valued column vector | Scalar or 1-by-L row vector | Applies a set of weights for the single frequency or for all L frequencies. |

N-by-L complex-valued
matrix | 1-by-L row vector | Applies each of the L columns of `‘Weights’` for
the corresponding frequency in the `FREQ` argument. |

**Example: **`'Weights',ones(N,M)`

**Data Types: **`double`

`'SteerAngle'`

— Subarray steering angle`[0;0]`

(default) | scalar | 2-element column vectorSubarray steering angle, specified as the comma-separated pair
consisting of `'SteerAngle'`

and a scalar or a 2-by-1
column vector.

If `'SteerAngle'`

is a 2-by-1 column vector,
it has the form `[azimuth; elevation]`

. The azimuth
angle must be between –180° and 180°, inclusive.
The elevation angle must be between –90° and 90°,
inclusive.

If `'SteerAngle'`

is a scalar, it specifies
the azimuth angle only. In this case, the elevation angle is assumed
to be 0.

This option applies only when the `'SubarraySteering'`

property
of the System
object is set to `'Phase'`

or `'Time'`

.

**Example: **`'SteerAngle',[20;30]`

**Data Types: **`double`

`'ElementWeights'`

— Weights applied to elements within subarray`1`

(default) | complex-valued Subarray element weights, specified as complex-valued
*N _{SE}*-by-

If `ElementWeights`

is a complex-valued
*N _{SE}*-by-

If `ElementWeights`

is a 1-by-*N* cell array. Each
cell contains a complex-valued column vector of weights for the corresponding subarray.
The column vectors have lengths equal to the number of elements in the corresponding
subarray.

To enable this name-value pair, set the `SubarraySteering`

property of the array to `'Custom'`

.

**Data Types: **`double`

**Complex Number Support: **Yes

`D`

— DirectivityCompute the directivity of a partitioned array formed from a single 20-element ULA with elements spaced one-quarter wavelength apart. The subarrays are then phase-steered towards 30 degrees azimuth. The directivities are computed at azimuth angles from 0 to 60 degrees.

```
c = physconst('LightSpeed');
fc = 3e8;
lambda = c/fc;
angsteer = [30;0];
ang = [0:10:60;0,0,0,0,0,0,0];
```

Create a partitioned ULA array using the `SubarraySelection`

property.

myArray = phased.PartitionedArray('Array',... phased.ULA(20,lambda/4),'SubarraySelection',... [ones(1,10) zeros(1,10);zeros(1,10) ones(1,10)],... 'SubarraySteering','Phase','PhaseShifterFrequency',fc);

Create the steering vector and compute the directivity.

myStv = phased.SteeringVector('SensorArray',myArray,... 'PropagationSpeed',c); d = directivity(myArray,fc,ang,'PropagationSpeed',c,'Weights',... step(myStv,fc,angsteer),'SteerAngle',angsteer)

`d = `*7×1*
-7.5778
-4.7676
-2.0211
10.0996
0.9714
-3.5575
-10.8439

Directivity describes the directionality of the radiation pattern of a sensor element or array of sensor elements.

Higher directivity is desired when you want to transmit more radiation in a specific direction. Directivity is the ratio of the transmitted radiant intensity in a specified direction to the radiant intensity transmitted by an isotropic radiator with the same total transmitted power

$$D=4\pi \frac{{U}_{\text{rad}}\left(\theta ,\phi \right)}{{P}_{\text{total}}}$$

where
*U*_{rad}*(θ,φ)* is the radiant
intensity of a transmitter in the direction *(θ,φ)* and
*P*_{total} is the total power transmitted by an
isotropic radiator. For a receiving element or array, directivity measures the sensitivity
toward radiation arriving from a specific direction. The principle of reciprocity shows that
the directivity of an element or array used for reception equals the directivity of the same
element or array used for transmission. When converted to decibels, the directivity is
denoted as *dBi*. For information on directivity, read the notes on Element Directivity and Array Directivity.

Computing directivity requires integrating the far-field transmitted radiant intensity over all directions in space to obtain the total transmitted power. There is a difference between how that integration is performed when Antenna Toolbox™ antennas are used in a phased array and when Phased Array System Toolbox™ antennas are used. When an array contains Antenna Toolbox antennas, the directivity computation is performed using a triangular mesh created from 500 regularly spaced points over a sphere. For Phased Array System Toolbox antennas, the integration uses a uniform rectangular mesh of points spaced 1° apart in azimuth and elevation over a sphere. There may be significant differences in computed directivity, especially for large arrays.

A modified version of this example exists on your system. Do you want to open this version instead?

You clicked a link that corresponds to this MATLAB command:

Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.

Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .

Select web siteYou can also select a web site from the following list:

Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.

- América Latina (Español)
- Canada (English)
- United States (English)

- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)

- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)