Main Content

eyeArea

Measure eye area

Since R2024a

collapse all in page

Syntax

a = eyeArea(obj)
a = eyeArea(obj,index)
a = eyeArea(___,Name=Value)

Description

a = eyeArea(obj) measures the eye area of the eye diagram or eye contour object obj.

a = eyeArea(obj,index) measures the eye area of the eye diagram or eye contour object obj at the index specified by index.

a = eyeArea(___,Name=Value) measures the eye area 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

collapse all

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

Index at which the function calculates the eye area, specified as a scalar. The function indexes the lowest eye opening as 1.

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 = eyeArea(obj,Plot=on) displays the plot of the eye diagram from the obj eye pattern object showing the eye area.

Symbol error rate for generating contours to measure eye area, 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 method for generating contours for generating contours to measure eye area.

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

Unit for the time coordinates for the calculation of the eye area.

Data Types: char

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

Data Types: char

Output Arguments

collapse all

Measured eye area for each eye in the diagram, returned as a column vector. The function indexes the eye openings from the lowest center amplitude to the highest.

Version History

Introduced in R2024a

See Also

| | |