Documentation

Scope Configuration

Control scope appearance and behavior

Description

Scope configuration properties control the appearance and behavior of a scope block. Create a scope configuration object with get_param, and then change property values using the object with dot notation.

Creation

myScopeConfiguration = get_param(gcbh,'ScopeConfiguration') creates a scope configuration object for the selected scope block.

Properties

expand all

Title on a scope window, specified with a character vector.

Number of input ports on a scope block, specified by a character vector. Maximum number of input ports is 96.

Block Configuration Property: Number of input ports

Display for setting display-specific properties, specified as a character vector. The number of a display corresponds to its column-wise placement index.

Dependency: Setting this property selects the display for setting the properties ShowGrid, ShowLegend, Title, PlotAsMagnitudePhase, YLabel, and YLimits.

Block Configuration Property: Active display

How to scale y-axes, specified as one of these values:

  • 'Manual' — Manually scale y-axes with the Scale Y-axis Limits button.

  • 'Auto' — Scale y-axes during and after simulation.

  • 'Updates' — Scale y-axes after specified number of block updates (time intervals).

Dependency: If this property is set to 'Updates', also specify the property AxesScalingNumUpdates.

Block Configuration Property: Axes scaling

Number of updates before scaling y-axes. Specified as a character vector.

Dependency: Activate this property by setting AxesScaling to 'Updates'.

Block Configuration Property: Number of updates

Save scope data to a variable in the MATLAB® workspace, specified as one of these values:

  • false — Inactivate logging and logging properties.

  • true — Activate logging and logging properties.

This property does not apply to floating scopes and scope viewers.

Dependency: If this property is set to true, also specify the properties DataLoggingVariableName and DataLoggingSaveFormat.

Block Configuration Property: Log data to workspace

Variable name for saving scope data in the MATLAB workspace, specified as text. This property does not apply to floating scopes and scope viewers.

Dependency: Activate this property by setting DataLogging to true.

Block Configuration Property: Variable name

Variable format for saving scope data to the MATLAB workspace, specified as one of these values:

  • 'Dataset' — Save data as a dataset object. This format does not support variable-size data, MAT-file logging, or external mode archiving. See Simulink.SimulationData.Dataset.

  • 'StructureWithTime' — Save data as a structure with associated time information. This format does not support single- or multiport frame-based data, or multirate data.

  • 'Structure' — Save data as a structure. This format does not support multi-rate data.

  • 'Array' — Save data as an array with associated time information. This format does not support multiport sample-based data, single or multiport frame-based data, variable-size data, or multi-rate data.

This property does not apply to floating scopes and scope viewers.

Dependency: Activate this property by setting DataLogging to true.

Block Configuration Property: Save format

Limit buffered data before plotting and saving data, specified as one of these values:

  • false — Save all the data. Setting this parameter to false can cause an out-of-memory error.

  • true — Save signal data at the end of a simulation.

For simulations with Stop time set to inf, always set this parameter to true.

Dependency: If this property is set to true, also specify the number of data values to plot and save with the property DataLoggingMaxPoints.

Block Configuration Property: Limit data points to last

Maximum number of data values to plot and save, specified as a character vector. The data values are from the end of a simulation.

Dependency: Activate this property by setting DataLoggingLimitDataPoints to true. Specifying this property limits the data values a scope plots and the data values saved in the MATLAB variable specified in DataLoggingVariableName.

Block Configuration Property: Text box to the right of the Limit data points to last check box.

Reduce scope data before plotting and saving, specified as one of these values:

  • false — Do not reduce buffered data.

  • true — Reduce buffered data.

Dependency: If this property is set to true, also specify DataLoggingDecimation.

Block Configuration Property: Decimation

How signal data is reduced before plotting and saving, specified as a character vector. The scope buffers every Nth data point, where N is the decimation factor you specify. A value of 1 buffers all data values.

Dependency: Activate this property by setting DataLoggingDecimateData to true.

Block Configuration Property: Text box to the right of the Decimation check box.

Frame-based processing of signals, specified as one of these values:

  • false — Process signal values in a channel at each time interval (sample based).

  • true — Process signal values in a channel as a group of values from multiple time intervals (frame based). Frame-based processing is available only with discrete input signals.

Block Configuration Property: Input processing

Number of display rows and columns, specified with as a two-element vector. The maximum layout dimension is four rows by four columns.

  • If the number of displays is equal to the number of ports, signals from each port appear on separate displays.

  • If the number of displays is less than the number of ports, signals from additional ports appear on the last y-axis.

Block Configuration Property: Layout button to the right of the Number of input ports text box

Maximize size of signal plots, specified as one of these values:

  • 'Auto' — If Title and YLabel are not specified, maximize all plots.

  • 'On' — Maximize all plots. Values in Title and YLabel are hidden.

  • 'Off' — Do not maximize plots.

Each of the plots expands to fit the full display. Maximizing the size of signal plots removes the background area around the plots.

Block Configuration Property: Maximize axes

Hide menu and toolbar, specified by one of these values:

  • false — Display menu and toolbar.

  • true — Hide menu and toolbar.

If you dock the scope, this property is inactive.

Open scope window, specified as one of these values:

  • true — Open Scope when simulation starts.

  • false — Do not open a closed Scope at the start of a simulation.

Block Configuration Property: Open at simulation start

Magnitude and phase plots, specified by one of these values:

  • false — Display signal plot.

    If the signal is complex, plot the real and imaginary parts on the same y-axis (display).

  • true — Display magnitude and phase plots.

    If the signal is real, plot the absolute value of the signal for the magnitude. The phase is 0 degrees for positive values and 180 degrees for negative values.

Dependency: Set ActiveDisplay before setting this property.

Block Configuration Property: Plot signals as magnitude and phase

Size and location of Scope window, specified as a four-element vector consisting of the left, bottom, width, and height positions, in pixels.

By default, a scope window appears in the center of your screen with a width of 560 pixels and height of 420 pixels.

Vertical and horizontal grid lines, specified as one of these values:

  • true — Display grid lines.

  • false — Hide grid lines.

Dependency: Set ActiveDisplay property before setting this property.

Block Configuration Property: Show grid

Time interval between Scope block updates during a simulation, specified as a character vector. This property does not apply to floating scopes and scope viewers.

Block Configuration Property: Sample Time

Signal legend, specified as one of these values:

  • false — Hide legend.

  • true — Show legend on active display.

Names listed in the legend are the signal names from the model. For signals with multiple channels, a channel index is appended after the signal name. See the Scope block reference for an example.

Dependency: Set ActiveDisplay property before setting this property.

Block Configuration Property: Show legend

Display or hide x-axis labels, specified as one of these values:

  • true — Display x-axis labels for the active display.

  • false — Hide x-axis labels.

Dependency: Set ActiveDisplay property before setting this property. If this property is set to true, also set TimeAxisLabels. If TimeAxisLabels is set to 'None', this property is inactive.

Block Configuration Property: Show time-axis label

How x-axis labels display, specified as one of these values:

  • 'All' — Display x-axis labels on all y-axes.

  • 'Bottom' — Display x-axis label only on the bottom y-axis.

  • 'None' — Do not display labels and deactivate ShowTimeAxisLabel property.

Dependency: Set ActiveDisplay before specifying this property. Activate this property by setting ShowTimeAxisLabel to true and setting Maximize axes to 'Off'.

Block Configuration Property: Time-axis labels

X-axis range offset, specified as a character vector or vector of character vectors. For input signals with multiple channels, enter a scaler or vector of offsets.

  • Scaler — Offset all channels of an input signal by the same value.

  • Vector — Independently offset the channels.

Block Configuration Property: Time display offset

Length of x-axis range to display, specified as one of these values:

  • Positive real number — Value less than the total simulation time.

  • 'Auto' — Difference between the simulation start and stop times.

The block calculates the beginning and end times of the x-axis range using the TimeDisplayOffset and TimeSpan properties. For example, if you set TimeDisplay to 10 and the TimeSpan to 20, the scope sets the x-axis range from 10 to 30.

Block Configuration Property: Time span

How to display data beyond the visible x-axis range, specified as one of these values:

  • 'Wrap' — Draw a full screen of data from left to right, clear the screen, and then restart drawing of data.

  • 'Scroll' — Move data to the left as new data is drawn on the right. This mode is graphically intensive and can affect run-time performance.

You can see the effects of this option only when plotting is slow with large models or small step sizes.

Block Configuration Property: Time span overrun action

Units to display on the x-axis, specified as one of these values:

  • 'Metric' — Display time units based on the length of the TimeSpan property.

  • 'None' — Display Time on the x-axis.

  • 'Seconds' — Display Time (seconds) on the x-axis.

Block Configuration Property: Time units

Title for a display, specified as text. The default value %<SignalLabel> uses the input signal name for the title.

Dependency: Set ActiveDisplay before setting this property.

Block Configuration Property: Title

Visibility of scope window, specified as one of these values:

  • true — Scope window visible.

  • false — Scope window hidden.

Block Configuration Property: No corresponding property

Y-axis label for active display, specified as a character vector.

Dependency: Set ActiveDisplay before setting this property. If PlotAsMagnitudePhase is true, the value of YLabel is hidden and plots are labeled Magnitude and Phase.

Block Configuration Property: Y-label

Minimum and maximum values of y-axis, specified as a two-element numeric vector.

Dependency: Set ActiveDisplay before setting this property. When PlotAsMagnitudePhase is true, this property specifies the y-axis limits for the magnitude plot. The y-axis limits of the phase plot are always [-180 180].

Block Configuration Property: Y-limits (Minimum) and Y-limits (Maximum)

Examples

Create Scope Configuration Object

This example creates a scope configuration object using the 'vdp' model.

open_system('vdp')
myScopeConfiguration = get_param('vdp/Scope','ScopeConfiguration');
myScopeConfiguration.NumInputPorts = '2';

Introduced in R2013a

Was this topic helpful?