isPolarizationCapable

System object: phased.CustomAntennaElement
Package: phased

Polarization capability

Syntax

flag = isPolarizationCapable(h)

Description

flag = isPolarizationCapable(h) 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

h — Custom antenna elementphased.CustomAntennaElement System object

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

Output Arguments

expand all

flag — Polarization-capability flag

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

Custom Antenna Element Polarization Capability

Determine whether the phased.CustomAntennaElement antenna element supports polarization when SpecifyPolarizationPattern is set to true.

h = phased.CustomAntennaElement(...
    'SpecifyPolarizationPattern',true);
isPolarizationCapable(h)
ans =

     1

The returned value true (1) shows that this antenna element supports polarization when the 'SpecifyPolarizationPattern' property is set to true.

Was this topic helpful?