eyeWidth

Measure horizontal eye opening

Since R2024a

Syntax

w = eyeWidth(obj)

w = eyeWidth(obj,amp)

[w,amp] = eyeWidth(___,Name=Value)

Description

w = eyeWidth(obj) measures the eye width of the eye diagram or eye contour object obj.

w = eyeWidth(obj,amp) measures the eye width of the eye diagram or eye contour object obj at the amplitude specified by amp.

[w,amp] = eyeWidth(___,Name=Value) measures the eye width and the returns the amplitude at which the eye height is measured using one or more name-value pair arguments in addition to the input argument in the previous syntax. Unspecified arguments take default values.

Input Arguments

obj — Eye diagram or eye contour object

eyeDiagramSI object | eyeContour object

Eye diagram or eye contour object, specified as an eyeDiagramSI System object™ or an eyeContour object.

amp — Amplitude at which eye width is calculated

row vector

Amplitude at which the function calculates the eye width, specified as a row vector. If you do not provide the amp argument, the function returns the best (largest) eye width across the eye opening.

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: w = eyeWidth(obj,Plot=on) displays the plot of the eye diagram from the obj eye contour object showing the eye width.

SER — Symbol error rate

0 | scalar

Symbol error rate for generating contours to measure eye width, specified as a scalar.

If the input object obj is an eye diagram object, you can define the SER value using this argument. If the input object obj is an eye contour object, the function uses the SER value set in the eye contour object and ignores this argument.

Data Types: double

Extrapolation — Extrapolation method

none (default) | dualdirac | gaussian | linear | spline | pchip | makima

Extrapolation method for generating contours for generating contours to measure eye width. For more information, see Extrapolation.

If the input object obj is an eye diagram object, you can define the Extrapolation method using this argument. If the input object obj is an eye contour object, the function uses the Extrapolation method set in the eye contour object and ignores this argument.

Data Types: char

TimeUnit — Unit for eye width

Seconds (default) | Samples | UI

Unit for the eye width w.

Data Types: char

Plot — Display eye width on plot

off (default) | on

Display a plot of the obj object showing the eye width.

Data Types: char

Output Arguments

w — Measured eye width

column vector

Measured eye width in amplitude units for each eye in the diagram, returned as a column vector. The elements of the vector correspond to the amp output.

amp — Amplitude at which eye widths are measured

row vector

Amplitude at which eye widths are measured, returned as a row vector.

Version History

Introduced in R2024a