margin

Calculate margins of eye contour from mask

Since R2024a

Syntax

minMargin = margin (maskObj,eyeObj)

minMargin = margin (eyeObj,maskObj)

minMargin = margin (___, Name=Value)

[minMargin, position, totalMargin, outerMargin] = margin (___)

Description

minMargin = margin (maskObj,eyeObj) returns the minimum margins in each direction from the eye mask object maskObj to the eye pattern or eye contour object eyeObj. .

minMargin = margin (eyeObj,maskObj) returns the minimum margins in each direction from the eye mask object maskObj to the eye pattern or eye contour object eyeObj. .

minMargin = margin (___, Name=Value) returns the minimum margins in each directions for each eye defined by the maskObj and eyeObj objects and the Name-Value pair arguments.

[minMargin, position, totalMargin, outerMargin] = margin (___) returns the various eye margins and the position at which the minimum eye margin was calculated.

Input Arguments

maskObj — Eye opening size and shape mask object

eyeMask object

Eye opening size and shape mask object from which eye margins are calculated.

eyeObj — Eye diagram or eye contour object

eyeDiagramSi object | eyeContour object

Eye diagram or eye contour object to which eye margins are calculated.

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: minMargin = margin(Mode=PerDirection) returns the minimum eye margins in the lower, upper, left, and right directions for each eye opening.

SER — Symbol error rate

0 (default) | scalar

Symbol error rate at which the function measures the eye margins.

Note

This property is only used when the eyeObj is an eyeDiagramSI System object™.

Data Types: double

Extrapolation — Extrapolation method to generate eye contours

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

Extrapolation method to generate eye contours used for measuring eye margins. For more information, see Extrapolation.

Note

This property is only used when the eyeObj is an eyeDiagramSI System object.

Data Types: char

Mode — Define how minimum eye margins are measured

PerAxis (default) | PerDirection

Define how minimum eye margins are measured:

• PerAxis — The function measures the minimum height and width margins for each eye.

• PerDirection — The function measures the minimum upper, lower, left, and right margins for each eye.

Data Types: char

Position — Location of mask in eye diagram

[] (default) | vector

Location of the mask in the eye diagram. When set, this argument temporarily overrides the Position property of the eyeMask object.

If the OptimizeTime property of the eyeMask is set to off, then only the x-axis coordinates of the Position are used.

Data Types: double

OptimizeTime — Optimize time coordinates for position of mask

off (default) | HeightMargin | WidthMargin

Optimize the time coordinates for the position of the mask in an eye for the best height margin or best width margin. This argument overwrites the OptimizeTime property of the eyeMask object.

Data Types: char

TimeUnit — Unit for time coordinates for location of eye mask

UI (default) | Seconds | Samples

Unit for the time coordinates for the location of the eye mask. When set, this argument temporarily overrides the TimeUnit property of the eyeMask object.

Data Types: char

Plot — Visualize results of minimum margin measurements

off (default) | on

Visualize the results of the minimum margin measurements.

Data Types: char

Output Arguments

minMargin — Minimum margins for each direction for each eye

vector | matrix

Row vectors of minimum margins for each direction for each eye.

position — Position vectors of minimum margin for each eye

vector | matrix

Position [X,Y] row vectors of the minimum margins for each eye.

totalMargin — Total available margin for each minimum margin

vector | matrix

Total available margin row vector for each minimum margin. Total available margin is defined as the sum of upper and lower or left and right margins at a given position.

outerMargin — Minimum margins from outer contour of data to mask limits

vector

Minimum margins from the outer contours of data to the upper limit and lower limit of the mask. The first element in the vector is the bottom margin.

Version History

Introduced in R2024a