Main Content

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

expand all

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

Example: phased.UCA()

Name-Value Arguments

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.

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

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

Logical flag specifying whether to show the local coordinate axes.

Data Types: logical

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 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

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

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

Plot title, specified as a character vector.

Example: 'My array plot'

Output Arguments

expand all

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

Examples

expand all

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);

Introduced in R2015a