PatternPlotOptions

Creates option list to customize 3-D radiation pattern for pattern overlay option

collapse all in page

Syntax

patternplot = PatternPlotOptions
patternplot = PatternPlotOptions(Name,Value)

Description

patternplot = PatternPlotOptions creates an option list for a 3-D radiation pattern for pattern overlay option.

example

patternplot = PatternPlotOptions(Name,Value) returns a pattern plot option list based on the specified properties. Properties not specified retain their default values.

Examples

collapse all

Open Live Script

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.

Input Arguments

collapse all

Name-Value Pair Arguments

Example: 'Transparency', 0.1

Specify optional comma-separated pairs of Name,Value pair arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (''). You can specify several name and value pair arguments in any order as Name1, Value1, ..., NameN, ValueN.

Transparency of the 3-D radiation pattern, specified as the comma-separated pair consisting of 'Transparency' and a scalar value between 0 and 1.

Example: 'Transparency', 0.5

Example: patternplot.Transparency = 0.5

Data Types: double

Relative size of the antenna to the radiation pattern, specified as the comma-separated pair of 'SizeRatio' and a positive scalar.

Example: 'SizeRatio', 1

Example: patternplot.SizeRatio = 1

Data Types: double

Position of the antenna with the pattern center as the origin, specified as the comma-separated pair consisting of 'AntennaOffset' and a three-element vector of [x, y, z] coordinates.

Example: 'AntennaOffset', [1,0,0]

Example: patternplot.AntennaOffset = [1,0,0]

Data Types: double

Scale of the radiation pattern, specified as the comma-separated pair consisting of 'MagnitudeScale' and 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: 'MagnitudeScale', [1,0]

Example: patternplot.MagnitudeScale = [1,0]

Data Types: double

See Also

| | |

Introduced in R2019a

Antenna Toolbox Documentation

Support