timescope

Display time-domain signals

Description

The timescope object displays signals in the time domain.

Scope features:

• Data Cursors — Measure signal values using vertical and horizontal cursors.

• Signal Statistics — Display the maximum, minimum, peak-to-peak difference, mean, median, and RMS values of a selected signal.

• Peak Finder — Find maxima, showing the x-axis values at which they occur.

• Bilevel Measurements — Measure transitions, overshoots, undershoots, and cycles.

• Triggers — Set triggers to sync repeating signals and pause the display when events occur.

Use Object Functions to show, hide, and determine visibility of the scope window.

Creation

Syntax

scope = timescope

scope = timescope(Name,Value)

Description

scope = timescope returns a timescope object, scope. This object displays real- and complex-valued floating and fixed-point signals in the time domain.

scope = timescope(Name,Value) returns a timescope object with properties set to the specified value. Specify properties and their values in quotes, separated by commas. You can specify name-value pair arguments in any order.

Properties

Most properties can be changed from the timescope UI.

Frequently Used

SampleRate — Sample rate of inputs

1 (default) | finite numeric scalar | vector

Sampling rate of the input signal, in hertz, specified as a finite numeric scalar or vector of scalars.

The inverse of the sample rate determines the x-axis (time axis) spacing between points in the displayed signal. When the value of NumInputPorts is greater than 1 and the sample rate is scalar, the object uses the same sample rate for all inputs. To specify different sample rates for each input, use a vector.

You can only set this property when creating the object or after calling release.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Sample Rate.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

TimeSpanSource — Source of time span

'auto' (default) | 'property'

Source of the time span for frame-based input signals, specified as one of the following:

• 'property' – The object derives the x-axis limits from the TimeDisplayOffset and TimeSpan properties.

• 'auto' – The x-axis limits are derived from the TimeDisplayOffset property, SampleRate property, and the number of rows in each input signal (FrameSize in the equations below). The limits are calculated as:

  • Minimum time-axis limit = TimeDisplayOffset

  • Maximum time-axis limit = TimeDisplayOffset + max(1/SampleRate.*FrameSize)

Dependency

When you set the TimeSpan property, TimeSpanSource is automatically set to 'property'.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Time Span.

Data Types: char | string

TimeSpan — Time span

10 (default) | positive scalar

Time span, in seconds, specified as a positive, numeric scalar value. The time-axis limits are calculated as:

• Minimum time-axis limit = TimeDisplayOffset

• Maximum time-axis limit = TimeDisplayOffset + TimeSpan

Dependencies

To enable this property, set TimeSpanSource to 'property'.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, edit Time Span.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

TimeSpanOverrunAction — Data overrun behavior

'scroll' (default) | 'wrap'

Specify how the scope displays new data beyond the visible time span as either:

• 'scroll' — In this mode, the scope scrolls old data to the left to make room for new data on the right of the scope display. This mode is beneficial for debugging and monitoring time-varying signals.

• 'wrap' — In this mode, the scope adds data to the left of the plot after overrunning the right of the plot.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Overrun Action.

Data Types: char | string

PlotType — Type of plot

'line' (default) | 'stairs'

Type of plot, specified as either:

• 'line' — Line graph, similar to the line or plot function.

• 'stairs' — Stair-step graph, similar to the stairs function. Stair-step graphs are useful for drawing time history graphs of digitally sampled data.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Plot Type.

Data Types: char | string

AxesScaling — Axes scaling mode

'onceatstop' (default) | 'auto' | 'manual' | 'updates'

When this property is set to:

• 'onceatstop' –– The limits are updated once at the end of the simulation (when release is called).

• 'auto' –– The scope attempts to always keep the data in the display while minimizing the number of updates to the axes limits.

• 'manual' –– The scope takes no action unless specified by the user.

• 'updates' –– The scope scales the axes once and only once after 100 updates to the visualization.

You can set this property only when creating the object.

Data Types: char | string

Advanced

LayoutDimensions — Display layout grid dimensions

[1,1] (default) | [numberOfRows, numberOfColumns]

Specify the layout grid dimensions as a two-element vector: [numberOfRows,numberOfColumns]. The grid can have a maximum of 4 rows and 4 columns.

If you create a grid of multiple axes, to modify the settings of individual axes, use the ActiveDisplay.

Example: scope.LayoutDimensions = [2,4]

Scope Window Use

On the Scope tab, click Display Grid () and select a specific number of rows and columns from the grid.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

TimeUnits — Units of x-axis

'seconds' (default) | 'none' | 'metric'

Specify the units used to describe the x-axis (time axis). You can select one of the following options:

• 'seconds' —The scope always displays the units on the x-axis as seconds. The scope shows the word Time(s) on the x-axis.

• 'none' — The scope does not display any units on the x-axis. The scope only shows the word Time on the x-axis.

• 'metric' — The scope displays the units on the x-axis as Time (s) changing the units to day, weeks, months, or years as you plot more data points.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Time Units.

Data Types: char | string

TimeDisplayOffset — Offset x-axis limits

0 (default) | scalar | vector

Specify, in seconds, how far to move the data on the x-axis. The signal value does not change, only the limits displayed on the x-axis change.

If you specify this property as a scalar, then that value is the time display offset for all channels. If you specify this property as a vector, each input channel can be a different time display offset

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Time Offset.

TimeAxisLabels — Time-axis labels

'all' (default) | 'bottom | 'none'

Time-axis labels, specified as:

• 'all' — Time-axis labels appear in all displays.

• 'bottom — Time-axis labels appear in the bottom display of each column.

• 'none' — No labels appear in any display.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Time Labels.

Data Types: char | string

MaximizeAxes — Maximize axes control

'auto' (default) | 'on' | 'off'

Specify whether to display the scope in the maximized-axes mode. In this mode, the axes are expanded to fit into the entire display. To conserve space, labels do not appear in each display. Instead, the tick-marks and their values appear on top of the plotted data. You can select one of the following options:

• 'auto' — The axes appear maximized in all displays only if the Title and YLabel properties are empty for every display. If you enter any value in any display for either of these properties, the axes are not maximized.

• 'on' — The axes appear maximized in all displays. Any values entered into the Title and YLabel properties are hidden.

• 'off' — None of the axes appear maximized.

Scope Window Use

On the scope window, click on to maximize axes, hiding all labels and insetting the axes values.

Data Types: char | string

BufferLength — Buffer length

50000 (default) | positive integer

Specify the length of the buffer used for each input signal as a positive integer.

You can set this property only when creating the object.

Scope Window Use

On the Scope tab, click Settings. Under Data and Axes, set Buffer Length.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Visualization

Name — Window name

'Time Scope' (default) | character vector | string scalar

Specify the name of the scope as a character vector or string scalar. This name appears as the title of the scope's figure window. To specify a title of a scope plot, use the Title property.

Data Types: char | string

Position — Window position

screen center (default) | [left bottom width height]

Scope window position in pixels, specified by the size and location of the scope window as a four-element vector of the form [left bottom width height]. You can place the scope window in a specific position on your screen by modifying the values of this property.

By default, the window appears in the center of your screen with a width of 800 pixels and height of 500 pixels. The exact values of the position depend on your screen resolution.

ChannelNames — Channel names

{''} (default) | cell array of character vectors

Specify the input channel names as a cell array of character vectors. The channel names appear in the legend, and on the Measurements tab under Select Channel. If you do not specify names, the channels are labeled as Channel 1, Channel 2, etc.

Dependency

To enable this property, set ShowLegend to true.

Data Types: char

ActiveDisplay — Active display for setting properties

1 (default) | integer

Active display used to set properties, specified by the integer display number. The number of a display corresponds to the display's row-wise placement index. Setting this property controls which display is used for the following properties: YLimits, YLabel, ShowLegend, ShowGrid, Title, and PlotAsMagnitudePhase.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, set Active Display.

Title — Display title

'' (default) | character vector | string scalar

Specify the display title as a character vector or a string scalar.

Dependency

When you set this property, ActiveDisplay controls the display that is updated.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, set Title.

Data Types: char | string

YLabel — y-axis label

'Amplitude' (default) | character vector | string scalar

Specify the text for the scope to display to the left of the y-axis.

Dependencies

This property applies only when PlotAsMagnitudePhase is false. When PlotAsMagnitudePhase is true, the two y-axis labels are read-only values "Magnitude" and "Phase", for the magnitude plot and the phase plot, respectively.

When you set this property, ActiveDisplay controls the display that is updated.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, set YLabel.

Data Types: char | string

YLimits — y-axis limits

[-10,10] (default) | [ymin, ymax]

Specify the y-axis limits as a two-element numeric vector, [ymin, ymax].

• If PlotAsMagnitudePhase is false, the default is [-10,10].

• If PlotAsMagnitudePhase is true, the default is [0,10]. This property specifies the y-axis limits of only the magnitude plot. The y-axis limits of the phase plot are always [-180,180]

Dependency

When you set this property, ActiveDisplay controls the display that is updated.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, set Y-Axis Limits.

ShowLegend — Show legend

false (default) | true

To show a legend with the input names, set this property to true.

From the legend, you can control which signals are visible. In the scope legend, click a signal name to hide the signal in the scope. To show the signal, click the signal name again.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, select Show Legend.

Data Types: logical

ShowGrid — Grid visibility

true (default) | false

Set this property to true to show grid lines on the plot.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, select Show Grid.

PlotAsMagnitudePhase — Plot signal as magnitude and phase

false (default) | true

Plot signal as magnitude and phased, specified as either:

• true – The scope plots the magnitude and phase of the input signal on two separate axes within the same active display.

• false – The scope plots the real and imaginary parts of the input signal on two separate axes within the same active display.

This property is useful for complex-valued input signals. Turning on this property affects the phase for real-valued input signals. When the amplitude of the input signal is nonnegative, the phase is 0 degrees. When the amplitude of the input signal is negative, the phase is 180 degrees.

Scope Window Use

On the Scope tab, click Settings. Under Display and Labels, select Magnitude Phase Plot.

Object Functions

To use an object function, specify the object as the first input argument.

hide	Hide scope window
show	Display scope window
isVisible	Determine visibility of scope
generateScript	Generate MATLAB script to create scope with current settings
step	Run System object algorithm
release	Release resources and allow changes to System object property values and input characteristics
reset	Reset internal states of System object

If you want to restart the simulation from the beginning, call reset to clear the scope window displays. Do not call reset after calling release.

Examples

View Sine Wave on Time Scope

Create a time-domain sinusoidal signal. Display the signal by calling the time scope object.

Create a sinusoidal signal with two tones, one at 0.3 kHz and the other at 3 kHz.

t = (0:1000)'/8e3;
xin = sin(2*pi*0.3e3*t)+sin(2*pi*3e3*t);

Create a timescope object and view the sinusoidal signal by calling the time scope object scope.

scope = timescope('SampleRate', 8e3,...
    'TimeSpanSource', 'property', ...
    'TimeSpan', 0.1);
scope(xin)

Run release to allow changes to property values and input characteristics. The scope automatically scales the axes.

release(scope);

Hide the scope window.

if(isVisible(scope))
    hide(scope)
end

Show the scope window.

if(~isVisible(scope))
    show(scope)
end

Use Bilevel Measurements Panel with Clock Input Signal

Create and Display Clock Input Signal

Load the clock data, x and t. Find the sample time, ts.

load clockex
ts = t(2)-t(1);

Create a timescope object and call the object to display the signal. To autoscale the axes and enable changes to property values and input characteristics, call release.

scope = timescope('SampleRate',1/ts,'TimeSpanSource','Auto');
scope(x);
release(scope);

Use Bilevel Measurements Panel to Find Settling Time

1. From the Measurements tab, select Aberrations.

Initially, the Time Scope does not display the Settling Time measurement. This absence occurs because the default value of the Settle Seek parameter is longer than the entire simulation duration.

2. In the Bilevel Settings > Settle Seek box, enter 2e-6 and press Enter.

Time Scope now displays a rising edge Settling Time value of 118.392 ns.

This settling time value is actually the statistical average of the settling times for all five rising edges. To show the settling time for only one rising edge, you can zoom in on that transition.

3. Hover over the upper right corner of the scope axes, and click the zoom button.

4. Click and drag to zoom in on one of the transitions.

Time Scope updates the rising edge Settling Time value to reflect the new time window.

Visualize Multiple Inputs with Different Sample Rates

This example shows how to visualize multiple inputs with different sample rates and plot the signals on multiple axes.

Generate three different sine waves and plot them on the timescope.

freq = 1/500;
t    = (0:100)'/freq;
t2   = (0:0.5:100)'/freq;
xin1 = sin(1/2*t);
xin2 = sin(1/4*t2);
xin  = sin(1/2*t2)+sin(1/4*t2);

scope = timescope('SampleRate', [freq freq/2 freq], ...
    'TimeSpanSource', 'property', ...
    'TimeSpan', 0.1,...
    'LayoutDimensions',[2,1]);
scope(xin, xin1, xin2)

release(scope)

Use Multiple Axes on Scope

This example show how to add titles, set y-axis limits, and modify properties when you have multiple axes on your timescope object.

Use the timescope to visualize three sine waves with two different sample rates.

freq = 1;
t    = (0:100)'/freq;
t2   = (0:0.5:100)'/freq;
xin1 = sin(1/2*t);
xin2 = sin(1/4*t2);
xin  = sin(1/2*t2)+sin(1/4*t2);
    
scope = timescope('SampleRate', [freq freq/2 freq], ...
     'TimeSpanSource', 'property', ...
    'TimeSpan', 100);
scope(xin, xin1, xin2)

Change the layout to add a second axis. The second and third inputs automatically move to the new second axis.

scope.LayoutDimensions = [2,1];

Modify the settings for the first axis by specifying the ActiveDisplay property to 1, then changing some properties for that axis.

scope.ActiveDisplay = 1;
scope.ShowGrid = false;
scope.Title = "Sine Wave 1";
scope.YLimits = [-2,2];

Repeat this process to modify the second axis.

scope.ActiveDisplay = 2;
scope.Title = "Sine Waves 2 & 3";
scope.YLimits = [-1,1];
release(scope)

View Sine Wave Input Signals at Different Sample Rates and Offsets

Create a dsp.SineWave with a 1000 Hz sampling frequency. Create a dsp.FIRDecimator object to decimate the sine wave by 2. Create a timescope object with two input ports.

Fs = 1000;  % Sampling frequency
sine = dsp.SineWave('Frequency',50,...
   'SampleRate',Fs, ...
   'SamplesPerFrame',100);
decimate = dsp.FIRDecimator; % To decimate sine by 2
scope = timescope('SampleRate',[Fs Fs/2], ...
   'TimeDisplayOffset',[0 38/Fs], ...
   'TimeSpanSource','Property',...
   'TimeSpan',0.25, ...
   'YLimits',[-1 1], ...
   'ShowLegend', true);

Call the dsp.SineWave object to create a sine wave signal. Use the dsp.FIRDecimator object to create a second signal that equals the original signal, but decimated by a factor of 2. Display the signals by calling the timescope object.

for ii = 1:2
     xsine = sine();
     xdec = decimate(xsine);
     scope(xsine,xdec)
end
release(scope)

Close the Time Scope window and clear the variables.

clear scope Fs sine decimate ii xsine xdec

Display Complex-Valued Input Signal

Create a vector representing a complex-valued sinusoidal signal, and create a timescope object. Call the scope to display the signal.

fs = 1000;
t = (0:1/fs:10)';
CxSine = cos(2*pi*0.2*t) + 1i*sin(2*pi*0.2*t);
CxSineSum = cumsum(CxSine);
scope = timescope('SampleRate',fs,'TimeSpanSource','Auto','ShowLegend',1);
scope(CxSineSum);
release(scope)

By default, when the input is a complex-valued signal, Time Scope plots the real and imaginary portions on the same axes. These real and imaginary portions appear as different-colored lines on the same axes within the same active display.

Change the PlotAsMagnitudePhase property to true and call release.

scope.PlotAsMagnitudePhase = true;
scope(CxSineSum);
release(scope)

Time Scope now plots the magnitude and phase of the input signal on two separate axes within the same active display. The top axes display magnitude and the bottom axes display the phase, in degrees.

Display Input Signal of Changing Size

This example shows how the timescope object visualizes inputs that change dimensions halfway through.

Create a vector that represents a two-channel constant signal. Create another vector that represents a three-channel constant signal. Create a timescope object. Call the scope with two inputs to display the signal.

fs = 10;
sigdim2 = [ones(5*fs,1) 1+ones(5*fs,1)];                   % 2-dim 0-5 s
sigdim3 = [2+ones(5*fs,1) 3+ones(5*fs,1) 4+ones(5*fs,1)];  % 3-dim 5-10 s
scope = timescope('SampleRate',fs,'TimeSpanSource','Property');
scope.PlotType = 'Stairs';
scope.TimeSpanOverrunAction = 'Scroll';
scope.TimeDisplayOffset = [0 5];
scope([sigdim2; sigdim3(:,1:2)], sigdim3(:,3));

In this example, the size of the input signal to the Time Scope changes as the simulation progresses. When the simulation time is less than 5 seconds, Time Scope plots only the two-channel signal, sigdim2. After 5 seconds, Time Scope also plots the three-channel signal, sigdim3.

Run the release method to enable changes to property values and input characteristics. The scope automatically scales the axes.

release(scope)

Find Heart Rate Using Peak Finder Panel with ECG Input Signal

Use Peak Finder panel of the Time Scope to measure a heart rate.

Create and Display ECG Signal

Create the electrocardiogram (ECG) signal. The custom ecg function helps generate the heartbeat signal.

function x = ecg(L)
a0 = [0,  1, 40,  1,   0, -34, 118, -99,   0,   2,  21,   2,   0,   0,   0];
d0 = [0, 27, 59, 91, 131, 141, 163, 185, 195, 275, 307, 339, 357, 390, 440];
a = a0 / max(a0);
d = round(d0 * L / d0(15));
d(15) = L;
for i = 1:14
    m = d(i) : d(i+1) - 1;
    slope = (a(i+1) - a(i)) / (d(i+1) - d(i));
    x(m+1) = a(i) + slope * (m - d(i));
end

x1 = 3.5*ecg(2700).';
y1 = sgolayfilt(kron(ones(1,13),x1),0,21);
n = (1:30000)';
del = round(2700*rand(1));
mhb = y1(n + del);
ts = 0.00025;

Create a timescope object and call the object to display the signal. To autoscale the axes and enable changes to property values and input characteristics, call release.

scope = timescope('SampleRate',1/ts);
scope(mhb);
release(scope)

Find Heart Rate

Use the Peak Finder measurements to measure the time between heart beats.

1. On the Measurements tab, select Peak Finder.

2. For the Num Peaks property, enter 10.

In the Peaks pane at the bottom of the window, the Time Scope displays a list of ten peak amplitude values and the times at which they occur.

The list of peak values shows a constant time difference of 0.675 second between each heartbeat. Based on the following equation, the heart rate of this ECG signal is about 89 beats per minute.

Close the Time Scope window and remove the variables you created from the workspace.

clear scope x1 y1 n del mhb ts

Tips

• To close the scope window and clear its associated data, use the MATLAB^® clear function.

• To hide or show the scope window, use the hide and show functions.

• Use the MATLAB mcc function to compile code containing a scope. You cannot open scope configuration dialogs if you have more than one compiled component in your application.