isVisible

Determine visibility of scope

Syntax

visibility = isVisible(scope)

Description

visibility = isVisible(scope) returns the visibility of the scope as logical, with 1 (true) for visible.

Examples

Hide and Show Time Scope

Create a sine wave signal and view it in the scope.

Fs = 1000;  % Sample rate
signal = dsp.SineWave(Frequency=50,SampleRate=Fs,...
    SamplesPerFrame=100);
scope = timescope(SampleRate=Fs,TimeSpanSource="property",...
    TimeSpan=0.25,YLimits=[-1 1]);
for ii = 1:2
     xsine = signal();
     scope(xsine)
end

Hide the scope window.

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

Show the scope window.

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

Clean up workspace variables.

clear scope Fs sine ii xsine

Input Arguments

scope — Scope object

scope object

Scope object, specified as one of the following:

• spectrumAnalyzer object

• dsp.ArrayPlot object

• dsp.LogicAnalyzer System object™

• timescope object

• dsp.DynamicFilterVisualizer object

Example: myScope = spectrumAnalyzer; visibility = isVisible(myScope)

Example: myTS = timescope; visibility = isVisible(myTS)

Output Arguments

visibility — Scope visibility

1 | 0

Scope visibility, returned as a logical 1 or a logical 0. If the scope display is showing, the isVisible function returns 1 (true). Otherwise, the function returns 0 (false).

Version History

Introduced in R2016b

R2024a: dsp.SpectrumAnalyzer object warns

The dsp.SpectrumAnalyzer System object warns in R2024a. Use the spectrumAnalyzer object instead.

Update Code

No updates to your code are required except replacing instances of dsp.SpectrumAnalyzer with spectrumAnalyzer.

This table shows how the isVisible function typically uses the dsp.SpectrumAnalyzer System object and explains how to update existing code to use the spectrumAnalyzer object.

Discouraged Usage	Recommended Replacement
scope = dsp.SpectrumAnalyzer; scope(randn(100000,1)) if(isVisible(scope)) hide(scope) end	scope = spectrumAnalyzer; scope(randn(100000,1)) if(isVisible(scope)) hide(scope) end

R2022b: New support for dsp.DynamicFilterVisualizer object

Starting in R2022b, the isVisible function supports the dsp.DynamicFilterVisualizer object.

R2022a: Support for dsp.SpectrumAnalyzer object will be removed

The isVisible function will stop supporting the dsp.SpectrumAnalyzer object in a future release. Use the spectrumAnalyzer object instead.