getSpectrumData

Save spectrum data shown in spectrum analyzer

Syntax

spectrumTable = getSpectrumData(scope)

Description

spectrumTable = getSpectrumData(scope) returns the spectrum and spectrogram displayed on the spectrum analyzer along with additional statistics about the spectrum.

Examples

Save Spectrum Data

Create a Spectrum Analyzer object and generate data.

scope = spectrumAnalyzer;
scope(randn(6000,3))

Save data from the last spectrum shown in the Spectrum Analyzer to a table.

specTable = getSpectrumData(scope)

specTable =

  1x3 table

    SimulationTime       Spectrum        FrequencyVector
    ______________    _______________    _______________

      {[0.5999]}      {1024x3 double}    {1024x1 double}

Input Arguments

scope — Spectrum analyzer

object name | block configuration

Spectrum Analyzer you want to query, specified as one of the following:

• spectrumAnalyzer object

• SpectrumAnalyzerBlockConfiguration object for a Spectrum Analyzer block

Output Arguments

spectrumTable — Data about current spectrum estimation

table

A spectrum table is returned containing the following fields:

Field	Description
SimulationTime	Simulation time
Spectrum	Power, power density, or RMS spectrum data
Spectrogram	Spectrogram data
MinHoldTrace	Minimum hold trace data
MaxHoldTrace	Maximum hold trace data
FrequencyVector	Frequency vector

Version History

Introduced in R2017b

R2024a: dsp.SpectrumAnalyzer System 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 getSpectrumData 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)) specTable = getSpectrumData(scope)	scope = spectrumAnalyzer; scope(randn(100000,1)) specTable = getSpectrumData(scope)

R2022a: Support for dsp.SpectrumAnalyzer object will be removed

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