eyeAmplitude

Measure eye amplitude

Since R2024a

Syntax

a = eyeAmplitude(obj)

a = eyeAmplitude(obj,time)

a = eyeAmplitude(___,Name=Value)

Description

a = eyeAmplitude(obj) measures the eye amplitude of the eye diagram object obj.

For a given eye opening, eye amplitude is defined as the difference between the mean value of the symbols above and below the eye opening. It is usually calculated in a narrow window around the timing origin.

a = eyeAmplitude(obj,time) measures the eye amplitude of the eye diagram object obj at the time specified by time.

a = eyeAmplitude(___,Name=Value) measures the eye amplitude of the eye diagram object obj 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 object

eyeDiagramSI object

Eye diagram object, specified as an eyeDiagramSI System object™.

time — Time when eye amplitude is calculated

row vector

Time at which the function calculates the eye amplitude, 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: a = eyeAmplitude(obj,Plot=on) displays the plot of the eye diagram from the obj eye pattern object showing the eye amplitudes.

TimeUnit — Unit for time coordinates

Seconds (default) | Samples | UI

Unit for the location of the eye amplitudes.

Data Types: char

Plot — Display eye amplitudes on plot

off (default) | on

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

Data Types: char

Output Arguments

a — Measured eye amplitude

matrix

Measured eye amplitude for each eye opening in the diagram. The function indexes the eye openings from the lowest center amplitude to the highest.

Version History

Introduced in R2024a