Main Content

getElementPosition

System object: phased.UCA
Package: phased

Positions of array elements

Syntax

pos = getElementPosition(sUCA)
pos = getElementPosition(sUCA,elemidx)

Description

pos = getElementPosition(sUCA) returns the element positions of the phased.UCA System object™, sUCA. pos is a 3-by-N matrix, where N is the number of elements in sUCA. Each column of pos defines the position of an element in the local coordinate system, in meters, using the form [x;y;z]. The origin of the local coordinate system is the center of the circular array.

pos = getElementPosition(sUCA,elemidx) returns only the positions of the elements that are specified in the element index vector elemidx.

Input Arguments

expand all

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

Example: phased.UCA

Element index vector, specified as a vector of positive integers each of which takes a value from 1 to N. The quantity N is the number of elements of the array.

Example: [1,2,3]

Output Arguments

expand all

Positions of array elements, returned as a 3-by-M real matrix. If the input argument elemidx is not specified, M is the number of elements of the array, N. If elemidx is specified, M is the dimension of elemidx.

Examples

expand all

Construct a 7-element UCA with a radius of 0.5 meters, and obtain the positions of the middle three elements.

sArray = phased.UCA('NumElements',7,'Radius',0.5);
pos = getElementPosition(sArray,[3,4,5])
pos = 3×3

    0.3117    0.5000    0.3117
   -0.3909         0    0.3909
         0         0         0

The output verifies that the position of the middle element of an array with an odd number of elements lies on the x-axis.

Introduced in R2015a