eyeHeight

Measure vertical eye opening

Since R2024a

Syntax

h = eyeHeight(obj)

h = eyeHeight(obj,time)

[h,t] = eyeHeight(___,Name=Value)

Description

h = eyeHeight(obj) measures the eye height of the eye diagram or eye contour object obj.

h = eyeHeight(obj,time) measures the eye height of the eye diagram or eye contour object obj at the time specified by time.

[h,t] = eyeHeight(___,Name=Value) measures the eye height and the returns the time 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.

time — Time when eye height is calculated

row vector

Time at which the function calculates the eye height, relative to the sampling clock edge, specified as a row vector.

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: h = eyeHeight(obj,Plot=on) displays the plot of the eye diagram from the obj eye diagram object showing the eye height.

SER — Symbol error rate

0 | scalar

Symbol error rate for generating contours to measure eye height, 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 height. 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 time coordinates

Seconds (default) | Samples | UI

Unit for the time coordinates for the location of the eye height.

Data Types: char

Plot — Display eye height on plot

off (default) | on

Display a plot of the eye diagram showing the eye height.

Data Types: char

Output Arguments

h — Measured eye height

matrix

Measured eye height in amplitude units for each eye in the diagram, returned as a matrix. The columns of the matrix correspond to the time values and rows correspond to the eye openings. The function indexes the eye openings from the lowest center amplitude to the highest.

t — Times at which eye heights are measured

row vector

Times at which eye heights are measured, returned as a row vector.

Version History

Introduced in R2024a