Main Content

isPolarizationCapable

System object: phased.CustomAntennaElement
Namespace: phased

Polarization capability

Syntax

flag = isPolarizationCapable(antenna)

Description

flag = isPolarizationCapable(antenna) returns a Boolean value, flag, indicating whether the phased.CustomAntennaElement System object™ supports polarization. An antenna element supports polarization if it can create or respond to polarized fields. This antenna object supports both polarized and nonpolarized fields.

Input Arguments

expand all

Custom antenna element, specified as a phased.CustomAntennaElement System object.

Output Arguments

expand all

Polarization-capability returned as a Boolean value true if the antenna element supports polarization or false if it does not. The returned value depends upon the value of the SpecifyPolarizationPattern property. If SpecifyPolarizationPattern is true, then flag is true. Otherwise it is false.

Examples

expand all

Show that the CustomAntennaElement antenna element supports polarization when the SpecifyPolarizationPattern property is set to true.

antenna = phased.CustomAntennaElement('SpecifyPolarizationPattern',true);
isPolarizationCapable(antenna)
ans = logical
   1

The returned value 1 shows that this antenna element supports polarization.