PatternPlotOptions

Pattern overlay options to customize 3-D radiation pattern

Description

The default PatternPlotOptions object creates a preset pattern overlay options configuration represented by its properties.

Use these options to change:

• Transparency of radiation pattern.

• Antenna geometry to radiation pattern size ratio.

• Pattern magnitude scale.

• Antenna position relative to radiation pattern.

Specify the PatternOptions argument in the following pattern functions using PatternPlotOptions object to apply these overlay options to the radiation plot.

• pattern

• patternCustom

• patternFromSlices

• patternFromAI

• patternMultiply

• patternSystem

Creation

Syntax

Description

patternplot = PatternPlotOptions creates default pattern overlay options configuration (represented by object properties) for a 3-D radiation pattern.

patternplot = PatternPlotOptions(PropertyName=Value) sets properties using one or more name-value arguments. PropertyName is the property name and Value is the corresponding value. You can specify several name-value arguments in any order as PropertyName1=Value1,...,PropertyNameN=ValueN. Properties that you do not specify, retain their default values.

For example, patternplot = PatternPlotOptions(Transparency=0.5) creates an options list for pattern overlay with transparency option's value set to 0.5.

Properties

Transparency — Transparency of 3-D radiation pattern

1 (default) | positive scalar in the range (0,1]

Transparency of the 3-D radiation pattern, specified as a scalar value in the range (0,1].

Example: 0.5

Data Types: double

SizeRatio — Relative size of antenna to radiation pattern

0.9000 (default) | positive scalar

Relative size of the antenna to the radiation pattern, specified as a positive scalar.

Example: 1

Data Types: double

MagnitudeScale — Scale of radiation pattern

[] (default) | two-element vector

Scale of the radiation pattern, specified as a two-element vector of minimum magnitude and maximum magnitude. If this property is empty, the radiation pattern plot is of the full range magnitude.

Example: [0,1]

Data Types: double

AntennaOffset — Position of antenna with pattern center as origin

[0 0 0] (default) | three-element vector

Position of the antenna with the pattern center as the origin, specified as a three-element vector of [x, y, z] coordinates.

Example: [1,0,0]

Data Types: double

Examples

Radiation Pattern of Helix Antenna

Plot the radiation pattern of a helix antenna with transparency specified as 0.5.

p = PatternPlotOptions

p = 
  PatternPlotOptions with properties:

      Transparency: 1
         SizeRatio: 0.9000
    MagnitudeScale: []
     AntennaOffset: [0 0 0]

p.Transparency = 0.5;
ant = helix;
pattern(ant,2e9,patternOptions=p)

To understand the effect of Transparency, chose Overlay Antenna in the radiation pattern plot.

This option overlays the helix antenna on the radiation pattern.

Version History

Introduced in R2019a