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(w1,h)

eyeMaskDiamond(w1,h)

eyeMaskHexagon(w1,w2,h)

eyeMaskFromFile(FileName)

Description

eyeMask creates an eyeMask object.

eyeMaskRectangle(w1,h) creates a rectangular eyeMask object with specified width and height.

eyeMaskDiamond(w1,h) creates a diamond shaped eyeMask object with specified width and height.

eyeMaskHexagon(w1,w2,h) creates a hexagonal eyeMask object with specified widths and height.

eyeMaskFromFile(FileName) creates an eyeMask object from design rules defined in a Signal Integrity Toolbox™ rules file or loads the eye mask from a MAT file.

Properties

Shape — Shape of eye mask

polyshape object

Shape of the eye mask, defined as a polyshape object. For more information, see polyshape.

Data Types: char

Position — Default 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, specified as a vector. Position is calculated relative to the timing origin and symbol threshold for any given eye in the eye diagram.

Data Types: double

OptimizeTime — How to optimize time coordinates of position of mask

off (default) | HeightMargin | WidthMargin

Define how to optimize the time coordinates of the position of the mask in an eye. Specify HeightMargin for the best height margin or WidthMargin for 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, specified as UI, seconds, or samples.

Data Types: char

UpperLimit — Upper amplitude limit of eye mask

scalar

Upper amplitude limit of the eye mask, specified as a scalar. This is an absolute limit and 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, specified as a scalar. This is an absolute limit and is not calculated relative to any other property.

Data Types: double

UserData — User specified data

additional data

User-specified additional data. This is additional data stored in the Signal Integrity Toolbox rules files and is not used by the object.

w1 — Width of rectangle, diamond, and center of hexagon eye masks

positive real scalar

The width of the rectangle or diamond eye masks or the width at the center of the hexagon eye mask, specified as a positive real scalar in UI.

Data Types: double

w2 — Width of top and bottom of hexagon eye mask

positive real scalar

The width at the top and bottom of the hexagon eye mask, specified as a positive real scalar in UI.

Data Types: double

h — Height of rectangle, diamond, or hexagon eye masks

positive real scalar

The height of the rectangle, diamond or hexagon eye masks, specified as a positive real scalar in UI.

Data Types: double

FileName — Name of rules file or MAT file that defines eyeMask object

rules file | MAT file

The name of the rules files or MAT file that defines the design rules to create the eyeMask object.

Data Types: char

Object Functions

margin	Calculate margins of eye contour from mask
plot	Plot eye diagram, eye contour, or eye mask object

Version History

Introduced in R2024a