eye_mask

EyeDiagram.eye_mask(points, xunits='ns', yunits='mV', enable_limits=False, upper_limit=500, lower_limit=-500, color=(0, 255, 0), xoffset='0ns', yoffset='0V', transparency=0.3)

Create an eye diagram in the plot.

Parameters:

pointslist

Points of the eye mask in the format [[x1,y1,],[x2,y2],...].

xunitsstr, optional

X points units. The default is "ns".

yunitsstr, optional

Y points units. The default is "mV".

enable_limitsbool, optional

Whether to enable the upper and lower limits. The default is False.

upper_limits float, optional

Upper limit if limits are enabled. The default is 500.

lower_limits str, optional

Lower limit if limits are enabled. The default is -500.

colortuple, optional

Mask in (R, G, B) color. The default is (0, 255, 0). Each color value must be an integer in a range from 0 to 255.

xoffsetstr, optional

Mask time offset with units. The default is "0ns".

yoffsetstr, optional

Mask value offset with units. The default is "0V".

transparencyfloat, optional

Mask transparency. The default is 0.3.

Returns:

bool

True when successful, False when failed.