timingError

Measure timing error from waveform

Since R2024b

Syntax

[TE,TEs] = timingError(x,y,SymbolTime = t)

[TE,TEs] = timingError(y,SampleInterval = s,SymbolTime = t)

[TE,TEs] = timingError(x,y,xr,yr)

[TE,TEs] = timingError(y,yr,SampleInterval = s)

[TE,TEs] = timingError(___,Name=Value)

[TE,TEs,TEindex,refTimes] = timingError(___)

Description

[TE,TEs] = timingError(x,y,SymbolTime = t) measures the timing error from input jittery waveform by using the specified symbol time.

[TE,TEs] = timingError(y,SampleInterval = s,SymbolTime = t) measures the timing error by using the specified sample interval and symbol time.

[TE,TEs] = timingError(x,y,xr,yr) measures the timing error from input jittery waveform with respect to the reference waveform.

[TE,TEs] = timingError(y,yr,SampleInterval = s) measures the timing error with respect to the reference waveform and specified sample interval.

[TE,TEs] = timingError(___,Name=Value) measures the timing error using name-value arguments. Unspecified arguments take default values.

[TE,TEs,TEindex,refTimes] = timingError(___) measures the amplitude, frequency, and phase of the timing error using the above arguments.

Input Arguments

x — Time coordinates of jittery signal

vector

Time coordinates of the jittery signal, specified as a monotonically increasing vector.

If you do not provide y, the function interprets x as edge times.

Data Types: double

y — Amplitude coordinates of jittery signal

vector | eyeDiagramSI object

Amplitude coordinates of the jittery signal, specified as a vector or as an eyeDiagramSI object.

If you do not provide x, the function assumes y is uniformly sampled at the rate specified by SampleInterval.

Data Types: double

xr — Time coordinates of reference signal

vector

Time coordinates of the reference signal, specified as a monotonically increasing vector.

Data Types: double

yr — Amplitude coordinates of reference signal

vector

Amplitude coordinates of the reference signal, specified as a vector. If you do not provide x, yr must be sampled at the same points as y.

Data Types: double

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: J = timingError(x,y,SampleInterval = s) calculates the timing error from the input waveform defined by (x,y) and sample interval specified by s.

SymbolThresholds — Thresholds to separate symbol levels in jittery waveform

vector

Thresholds to separate symbol levels in the jittery waveform, specified as a vector. If you do not provide SymbolThresholds, the function calculates it from the histogram of y.

Data Types: double

ReferenceThresholds — Thresholds to separate symbol levels in reference waveform

vector

Thresholds to separate symbol levels in the reference waveform, specified as a vector. If you do not provide ReferenceThresholds, the function calculates it from the histogram of yr.

Data Types: double

SampleInterval — Sample time for uniformly sampled jittery and reference waveforms

scalar

Sample time for uniformly sampled jittery and reference waveforms, specified as a scalar.

When you provide the time vectors of jittery and reference signals, the function ignores SampleInterval and uses time vectors instead.

Data Types: double

SymbolTime — Symbol time for uniformly sampled jittery and reference waveforms

scalar

Symbol time for uniformly sampled jittery and reference waveforms, specified as a scalar. For clock waveforms, SymbolTime is half the of the period.

Data Types: double

Match — Options to compare data edge to clock edge

time (default) | order

Options to compare the data edge to the clock edge, specified as one of these:

• time — Compares the closest edge times.

• order — Compares the first edge on each set.

The function uses this argument in two scenarios only:

• Both the measured and reference waveforms are clocks.

• The measured waveform is a data waveform and the reference waveform is a clock waveform.

When both waveforms are data waveforms with the same pattern, the function matches the edges is based on the pattern.

DebounceGain — Positive feedback gain for hysteresis

0.5 (default) | real scalar in the range [0, 1]

Positive feedback gain for hysteresis, specified as a real scalar in the range [0, 1]. The function uses DebounceGain to calculate the modified thresholds by using the equation:

$${\text{threshold}}_{\text{new}}(i)={\text{threshold}}_{\text{old}}(i)+\text{DebounceGain}·\frac{\text{EyeAmplitude}(i)}{2}$$

Data Types: double

DebounceUI — Fraction of unit interval to hold hysteresis threshold level

1/3 (default) | nonnegative scalar in the range [0, 1]

Fraction of a unit interval to hold the hysteresis threshold level before returning to the nominal threshold, specified as a nonnegative scalar in the range [0, 1].

Data Types: double

DelayTime — Custom channel delay

[] (default) | real scalar

Custom channel delay, specified as a real scalar.

If your data has aggressive decision feedback equalization, you can manually override the channel delay compensation calculated by the jitter function and specify the delay of the measured waveform (x,y) with respect to the reference waveform (xr,yr). A positive Delaytime indicates that a reference edge matches to an edge later in time in the measured signal. A negative Delaytime indicates that a measured edge matches to an edge later in time in the reference signal.

Data Types: double

Output Arguments

TE — Chronological timing error

vector

Chronological timing error, returned as a vector.

TEs — Sorted timing error based on measured waveform edge

cell array

Sorted timing error based on the measured waveform edge, returned as a cell array. Each cell contains a type of edge (symbol transition). The rows of the cell array denotes the origin symbols and the columns denote the destination symbol.

TEindex — Index for timing error

N-by-3 matrix

Index for timing error, returned as an N-by-3 matrix. N is equal to the number of elements in the TE vector.

refTimes — Reference edge time

vector

Reference edge time for each element of TE vector, returned as a vector of the same length as TE. The edge times in the jittery waveform is the sum of refTimes and TE.

Version History

Introduced in R2024b