# arrayFactor

Array factor in dB

## Syntax

``arrayFactor(array,frequency)``
``arrayFactor(array,frequency,azimuth,elevation)``
``arrayFactor(___,Name=Value)``
``[af] = arrayFactor(array,frequency)``
``[af,azimuth,elevation] = arrayFactor(___)``
``[af,azimuth,elevation] = arrayFactor(___,Name=Value)``

## Description

example

````arrayFactor(array,frequency)` plots the 3-D array factor of the specified array at the specified frequency value in dB.```
````arrayFactor(array,frequency,azimuth,elevation)` plots the array factor of the specified array over the specified frequency, azimuth, and elevation values.```
````arrayFactor(___,Name=Value)` plots the array factor of the specified array using additional options specified by one or more name-value arguments. Specify name-value arguments after all other input arguments.```
````[af] = arrayFactor(array,frequency)` returns the 3-D array factor of the specified array at the specified frequency value.```
````[af,azimuth,elevation] = arrayFactor(___)` returns the array factor of the specified array at the specified frequency, azimuth, and elevation values.```
````[af,azimuth,elevation] = arrayFactor(___,Name=Value)` returns the array factor using additional options specified by one or more name-value arguments. Specify name-value arguments after all other input arguments.```

## Examples

collapse all

Plot the array factor of a default rectangular array at a frequency of 70 MHz.

```ra = rectangularArray; arrayFactor(ra,70e6);```

## Input Arguments

collapse all

Antenna array to calculate the array factor, specified as an array object from these:

Example: ```r = rectangularArray; arrayFactor (r,70e6)```. Calculates the array factor of a rectangular array.

Frequency value used to calculate array factor, specified as a scalar in Hz.

Example: `70e6`

Data Types: `double`

Azimuth angles used to calculate the array factor, specified as a vector in degrees.

Example: `–90:5:90`

Data Types: `double`

Elevation angles used to calculate the array factor, specified as a vector in degrees.

Example: `0:1:360`

Data Types: `double`

### 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.

Example: `arrayFactor(rectangularArray,70e6,CoordinateSystem="rectangular")`

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

Example: `arrayFactor(rectangularArray,70e6,'CoordinateSystem','rectangular')`

Coordinate system of array factor plot, specified as either `"polar"`, `"rectangular"`, or `"uv"`.

Example: `"rectangular"`

Data Types: `string`

Parameter to change properties of pattern plot, specified as a `PatternPlotOptions` object. The `PatternPlotOptions` properties that you can vary are:

• `Transparency`

• `MagnitudeScale`

Other `PatternPlotOptions` properties used in the `PatternOptions` for the inset figure are ignored in the `arrayFactor`.

Example: ```p = PatternPlotOptions(Transparency=0.1);``` creates a pattern plot with a transparency of 0.1. `arrayFactor(rectangularArray,70e6,PatternOptions=p)` sets the pattern options for the `arrayFactor`.

Data Types: `double`

## Output Arguments

collapse all

Array factor, returned as a matrix in `dB`. The matrix size is the product of number of elevation values and number of azimuth values.

Azimuth values used to calculate the array factor, returned as a vector in degrees.

Elevation values used to calculate the array factor, returned as a vector in degrees.

## Version History

Introduced in R2017a