# polar

Plot specified object parameters on polar coordinates

## Syntax

``p = polar(budgetobj,i,j)``
``lineseries = polar(cktobj,'parameter1',...,'parametern')``
``lineseries = polar(___,x-axis parameter,x-axis format,'condition1',value1,...,'conditionm',valuem,'freq',freq,'pin',pin)``

## Description

````p = polar(budgetobj,i,j)` plots the (i,j)th s-parameter on polar plot for an `rfbudget` object. `p` is a polar plot function object. For more information about properties of `p`, see Polar Properties.```

example

````lineseries = polar(cktobj,'parameter1',...,'parametern')` plots the parameters `parameter1`, `...`, `parametern` on polar plot for a circuit object `cktobj`.The `polar` function returns a column vector of handles to `lineseries` objects, one handle per element.```

example

````lineseries = polar(___,x-axis parameter,x-axis format,'condition1',value1,...,'conditionm',valuem,'freq',freq,'pin',pin)` plots the specified parameters at the specified operating conditions on polar plot for a circuit object, `cktobj`. Use this option with the input arguments in the previous syntax. NoteFor all circuit objects except those that contain data from a data file, you must use the `analyze` method to perform a frequency domain analysis before calling `polar`.Use the function `polarpattern` (Antenna Toolbox), or the MATLAB® function `polarplot` to plot parameters that are not part of a `rfckt` or `rfbudget` object, but are specified as vector data. ```

## Examples

collapse all

Create an RF budget object from `default.s2p`.

```Sa = nport('default.s2p'); rfobj = rfbudget(Sa,Sa.NetworkData.Frequencies,-30,10);```

Plot S11 on polar plot.

```p = polar(rfobj,1,1); p.LineStyle = ':';```

In the newly opened figure window, click View > Figure Toolbar, then hover over the dataset to see the parameters specific to a particular point. You can right click to interact with the plot.

Create an amplifier object from |default.s2p|.

`amp = read(rfckt.amplifier,'default.s2p');`

Plot S11 on polar plot.

`lineseries = polar(amp,'S11')`

```lineseries = Line (S_{11}) with properties: Color: [0 0.4470 0.7410] LineStyle: '-' LineWidth: 0.5000 Marker: 'none' MarkerSize: 6 MarkerFaceColor: 'none' XData: [-0.7247 -0.7318 -0.7388 -0.7457 -0.7525 -0.7593 -0.7661 -0.7728 -0.7794 -0.7859 -0.7924 -0.7989 -0.8055 -0.8120 -0.8185 -0.8249 -0.8312 -0.8373 -0.8431 -0.8487 -0.8539 -0.8587 -0.8632 -0.8673 -0.8711 -0.8748 ... ] (1x191 double) YData: [-0.4813 -0.4715 -0.4616 -0.4517 -0.4419 -0.4320 -0.4221 -0.4123 -0.4024 -0.3926 -0.3827 -0.3729 -0.3632 -0.3535 -0.3438 -0.3341 -0.3244 -0.3145 -0.3046 -0.2946 -0.2844 -0.2741 -0.2637 -0.2532 -0.2427 -0.2322 ... ] (1x191 double) Use GET to show all properties ```

## Input Arguments

collapse all

RF budget object, specified as a `rfbudget` object.

Circuit object (`rfckt`) object, specified as an object handle.

To get a list of valid parameters for `cktobj`, type `listparam(cktobj)`.

The independent variable along the x-axis to plot the specified parameters along the y-axis, specified as a character vector or string. Several `x-axis parameter` values are available for all objects. When you import `rfckt.amplifier`, `rfckt.mixer`, or `rfdata.data` object specifications from a `.p2d` or `.s2d` file, you can also specify any operating conditions from the file that have numeric values, such as bias.

The following table shows the most commonly available parameters and the corresponding `x-axis parameter` values. The default settings listed in the table are used if `x-axis parameter` is not specified.

Parameter Name`x-axis parameter` Values
`Pout`, `Phase`, `LS11`, `LS12`, `LS21`, `LS22``Pin` (default), `Freq`
`S11`, `S12`, `S21`, `S22`, `NF`, `OIP3`, `VSWRIn`, `VSWROut`, `GammaIn`, `GammaOut`, `FMIN`, `GammaOPT`, `RN``Freq`
`AM/AM`, `AM/PM``AM`

The format used for the specific `x-axis parameter`, specified as a character vector or string. No `x-axis format` specification is needed when `x-axis parameter` is an operating condition.

The following table shows the `x-axis format` values that are available for the `x-axis parameter` values listed in the preceding table, along with the default settings that are used if ```x-axis format``` is not specified.

`x-axis parameter` Values`x-axis format` Values
`Pin``dBm` (default), `mW`, `W`, `dBW`
`Freq`

`THz`, `GHz`, `MHz`, `KHz`, `Hz`

By default, `x-axis format` is chosen to provide the best scaling for the given ```x-axis parameter``` values.

`AM``Magnitude (decibels)` (default), ```Magnitude (linear)```

### Name-Value Arguments

Specify optional pairs of arguments as `Name1=Value1,...,NameN=ValueN`, where `Name` is the argument name and `Value` is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose `Name` in quotes.

Example: `lineseries = polar(h,'Freq',2.1e9)`

Optional condition-value pairs at which to plot the specified parameters, specified as a series of `'condition',value` pairs separated by commas. These pairs are usually operating conditions from a `.p2d` or `.s2d` file. For some parameters, you can specify a set of frequency or input power values at which to plot the specified parameter.

For example:

• When plotting large-signal S-parameters as a function of input power, you can specify frequency points of interest using condition-value pairs.

• When plotting large-signal S-parameters as a function of frequency, you can specify input power levels of interest using condition-value pairs.

• When plotting parameters as a function of an operating condition, you can specify both frequency and input power values using condition-value pairs.

The optional frequency value, in Hz, at which to plot the specified parameters. `Freq` is specified as the comma-separated pair of `'Freq'`, and a scalar value.

The optional input power value, in dBm, at which to plot the specified parameters. `pin` is specified as the comma-separated pair of `'pin'`, and a scalar value.

## Output Arguments

collapse all

Polar plot function object, returned as object handle.

For more information about properties of `p`, see Polar Properties.

`lineseries` object, returned as a column vector of object handles.

## Tips

• If you do not specify any operating conditions as arguments to the `polar` method, then the method plots the parameter values based on the currently selected operating condition.

• If you specify one or more operating conditions, the `polar` method plots the parameter values based on those operating conditions.

• When you use an operating condition for the `x-axis parameter` input argument, the method plots the parameters for all operating condition values.

• Use the Property Editor (`propertyeditor`) or the MATLAB `set` function to change the Line Properties.

• The reference pages for MATLAB functions such as `figure`, `axes`, and `text` list available properties and provide links to detailed descriptions.

## Version History

Introduced before R2006a