jitterTotal

Measure total jitter metric from waveform

Since R2024b

Syntax

[TJrms,TJpkpk] = jitterTotal(x,y,SymbolTime = t)

[TJrms,TJpkpk] = jitterTotal(y,SampleInterval = s,SymbolTime = t)

[TJrms,TJpkpk] = jitterTotal(x,y,xr,yr)

[TJrms,TJpkpk] = jitterTotal(y,yr,SampleInterval = s)

[TJrms,TJpkpk] = jitterTotal(___,Name=Value)

[TJrms,TJpkpk,TJpdf,binEdges] = jitterTotal(___)

Description

[TJrms,TJpkpk] = jitterTotal(x,y,SymbolTime = t) measures the total rms and peak-to-peak jitter from input jittery waveform with specified symbol time.

Total jitter is the net jitter in a waveform. The function measures total jitter by taking the rms and peak-to-peak values of the timing error sequence.

[TJrms,TJpkpk] = jitterTotal(y,SampleInterval = s,SymbolTime = t) measures the total jitter from input jittery waveform with specific sample interval and symbol time.

[TJrms,TJpkpk] = jitterTotal(x,y,xr,yr) measures the total jitter from input jittery waveform with respect to the reference waveform.

[TJrms,TJpkpk] = jitterTotal(y,yr,SampleInterval = s) measures the total jitter with respect to reference waveform and specific sample interval.

[TJrms,TJpkpk] = jitterTotal(___,Name=Value) measures the total jitter using the Name-Value pair arguments. Unspecified arguments take default values.

[TJrms,TJpkpk,TJpdf,binEdges] = jitterTotal(___) measures the total rms and peak-to-peak jitter using the above arguments. It also estimates the probability density functions (PDFs) and bin edges for the total jitter.

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

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: [TJrms,TJpkpk] = jitterTotal(x,y,SampleInterval = s,Plot = on) calculates and plots the histogram of the total jitter from the input waveform defined by (x,y) and the specified sample interval.

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.

Plot — Option to display histogram of total jitter

false or 0 (default) | true or 1

Option to display histogram of random jitter, specified as true (1) or false or (0).

Data Types: logical

BinEdges — Bin edges for histograms used to estimate TJ PDF

vector

Bin edges for histograms used to estimate total jitter PDF, specified as a vector.

By default, the function distributes BinEdges evenly with twice the resolution of Scott's rule.

Data Types: double

Output Arguments

TJrms — RMS total jitter

scalar

Observed rms total jitter or standard deviation of the total jitter, returned as a scalar.

TJpkpk — Peak-to-peak total jitter

scalar

Observed peak-to-peak total jitter, returned as a scalar.

TJpdf — PDF estimate of total jitter

vector

PDF (probability distribution function) estimates of the total jitter, returned as a vector.

binEdges — Bin edges for TJ PDFs

vector

Bin edges for the PDFs for the total jitter, returned as a vector.

Version History

Introduced in R2024b