timeIntervalError

Measure time interval error

Since R2024b

Syntax

[TIE,TIEs] = timeIntervalError(x,y,SymbolTime = t)

[TIE,TIEs] = timeIntervalError(y,SampleInterval = s,SymbolTime = t)

[TIE,TIEs] = timeIntervalError(x,y,xr,yr)

[TIE,TIEs] = timeIntervalError(y,yr,SampleInterval = s)

[TIE,TIEs,TIEindex] = timeIntervalError(___,Name=Value)

Description

[TIE,TIEs] = timeIntervalError(x,y,SymbolTime = t) measures the time interval error from input jittery waveform by using the specified symbol time.

[TIE,TIEs] = timeIntervalError(y,SampleInterval = s,SymbolTime = t) measures the time interval error by using the specified sample interval and symbol time.

[TIE,TIEs] = timeIntervalError(x,y,xr,yr) measures the time interval error from input jittery waveform with respect to the reference waveform.

[TIE,TIEs] = timeIntervalError(y,yr,SampleInterval = s) measures the time interval error with respect to the reference waveform and specified sample interval.

[TIE,TIEs,TIEindex] = timeIntervalError(___,Name=Value) measures the time interval error using name-value arguments. Unspecified arguments take default values.

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

Interval — Length of time interval in edge occurrences

1 (default) | scalar

Length of the time interval in the edge occurrences, specified as a scalar.

For any to symbol transitions, if the starting and ending symbols are the same, they can be considered edges of the same type. Interval is the length in edges of the same type between edges used to calculate the TIE. For example, setting Interval to 1 spans one period of a periodic 2-level waveform.

Data Types: double

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.

Output Arguments

TIE — Chronological time interval error

vector

Chronological time interval error, returned as a vector.

TIEs — Sorted time interval error based on measured waveform edge

cell array

Sorted time interval 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.

TIEindex — Index for time interval error

N-by-3 matrix

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

Version History

Introduced in R2024b