Coverage for src / tracekit / analyzers / eye / __init__.py: 100%

1"""Eye diagram analysis module. 

2 

3This module provides eye diagram generation and metrics for serial 

4data signal quality analysis. 

5 

6 

7Example: 

8 >>> from tracekit.analyzers.eye import generate_eye, eye_height, eye_width 

9 >>> eye = generate_eye(trace, unit_interval=1e-9) 

10 >>> height = eye_height(eye) 

11 >>> width = eye_width(eye) 

12 

13References: 

14 IEEE 802.3: Ethernet Physical Layer Specifications 

15 OIF CEI: Common Electrical I/O 

16""" 

17 

18from tracekit.analyzers.eye.diagram import ( 

19 EyeDiagram, 

20 generate_eye, 

21 generate_eye_from_edges, 

22) 

23from tracekit.analyzers.eye.metrics import ( 

24 EyeMetrics, 

25 crossing_percentage, 

26 eye_contour, 

27 eye_height, 

28 eye_width, 

29 measure_eye, 

30 q_factor, 

31) 

32 

33__all__ = [ 

34 # Diagram generation 

35 "EyeDiagram", 

36 # Metrics 

37 "EyeMetrics", 

38 "crossing_percentage", 

39 "eye_contour", 

40 "eye_height", 

41 "eye_width", 

42 "generate_eye", 

43 "generate_eye_from_edges", 

44 "measure_eye", 

45 "q_factor", 

46]