viewArray

System object: phased.UCA
Package: phased

View array geometry

Syntax

viewArray(H)
viewArray(H,Name,Value)
hPlot = viewArray(___)


Description

viewArray(H) plots the geometry of the array specified in H.

viewArray(H,Name,Value) plots the geometry of the array, with additional options specified by one or more Name,Value pair arguments.

hPlot = viewArray(___) returns the handle of the array elements in the figure window. All input arguments described for the previous syntaxes also apply here.

Input Arguments

H — Uniform circular array

System object™

Uniform circular array specified as a phased.UCA System object.

Example: phased.UCA()

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Parent — Handle to axes

real-valued scalar

Handle to the axes along which the array geometry is displayed.

ShowNormals — Option to show normal vectors

false (default) | true

Option to show normal directions, specified as the comma-separated pair consisting of 'ShowNormals' and a Boolean value.

• true — show the normal directions of all elements in the array

• false — plot the elements without showing normal directions

Example: false

Data Types: logical

ShowLocalCoordinates — Show local coordinates

true (default) | false

Logical flag specifying whether to show the local coordinate axes.

Data Types: logical

ShowAnnotation — Show aperture size and element spacing annotations

true (default) | false

Logical flag specifying whether to show the annotations in the UI panel of the figure. Annotation shows aperture size and element spacing based on array axis of array.

Data Types: logical

Orientation — Array orientation

[0;0;0] (default) | 3-by-1 real-valued vector

Orientation of the array, specified as a 3-by-1 column vector containing the rotation angles with respect to the x-, y-, and z-axes of the local coordinate system, respectively.

Data Types: double

ShowTaper — Option to show taper magnitude

false (default) | true

Option to show taper magnitude, specified as the comma-separated pair consisting of 'ShowTaper' and a Boolean value.

• true — change the element color brightness in proportion to the element taper magnitude

• false — plot all elements using the same color

Data Types: logical

ShowIndex — Element indices to show

'None' (default) | vector of positive integers | 'All'

Element indices to show in the figure, specified as the comma-separated pair consisting of 'ShowIndex' and a vector of positive integers. Each number in the vector must be an integer between 1 and the number of elements. To show all of indices of the array, specify 'All'. To suppress all indices, specify 'None'.

Example: [1,2,3]

Data Types: double

Title — Plot title

'Array Geometry' (default) | character vector

Plot title, specified as a character vector.

Example: 'My array plot'

Output Arguments

hPlot — Handle of array elements

scalar

Handle of array elements in the figure window, specified as a scalar.

Examples

View UCA Array

Construct an 7-element UCA of isotropic antenna elements with a Taylor window taper. Design the array to have a radius of 0.5 meters. Then, draw the array showing the element normals, element indices, and element taper shading.

Nelem = 7;
R = 0.5;
taper = taylorwin(Nelem);
sArray = phased.UCA(Nelem,R,'Taper',taper.');
w = getTaper(sArray);
viewArray(sArray,'ShowNormals',true,'ShowIndex','All','ShowTaper',true);

Version History

Introduced in R2015a