eyeMask

Shape and size mask of eye opening

Since R2024a

Description

Use the eyeMask object to define the shape and size of an eye opening. The object includes a set of parameters that determine how the shape is placed in an eye contour when its margin is being calculated. You can fix the mask in a single, pre-determined position or position it at the timing origin and the symbol threshold level. You can specify a single fixed position or a set of fixed positions. The mask can skew within the eye opening.

Creation

Syntax

eyeMask

eyeMaskRectangle

eyeMaskDiamond

eyeMaskHexagon

eyeMaskFromFile

Description

eyeMask creates an eyeMask object.

eyeMaskRectangle creates a rectangular eyeMask object.

eyeMaskDiamond creates a diamond shaped eyeMask object.

eyeMaskHexagon creates a hexagonal eyeMask object.

eyeMaskFromFile creates an eyeMask object from design rules defined in a Signal Integrity Toolbox™ rules file or loads it from a MAT file.

Properties

Shape — Polyshape object defining shape of eye mask

object

Polyshape object defining the shape of the eye mask.

Data Types: char

Position — Position of origin of shape of mask in eye diagram

vector

Default position of the origin of the Shape of the mask in an eye diagram. Position is calculated relative to the timing origin and symbol threshold for any given eye in the eye diagram.

Data Types: double

OptimizeTime — Optimize time coordinates of position of mask

off (default) | HeightMargin | WidthMargin

Optimize the time coordinates of the position of the mask in an eye for the best height margin or best width margin.

Data Types: char

TimeUnit — Unit for time coordinates for position and shape

UI (default) | Seconds | Samples

Unit for the time coordinates for the Position and Shape properties of the eye mask.

Data Types: char

UpperLimit — Upper amplitude limit of eye mask

scalar

Upper amplitude limit of the eye mask. This is an absolute limit, it is not calculated relative to any other property.

Data Types: double

LowerLimit — Lower amplitude limit of eye mask

scalar

Lower amplitude limit of the eye mask. This is an absolute limit, it is not calculated relative to any other property.

Data Types: double

UserData — User specified data

data

User-specified data. This may be from the Signal Integrity Toolbox rules files and is not used by the object.

Object Functions

margin

plot

Version History

Introduced in R2024a