getAnalysisOptions

Get analysis options of displays in Filter Analyzer app

Since R2024a

collapse all in page

Syntax

opts = getAnalysisOptions(fa)
opts = getAnalysisOptions(fa,DisplayNums=dispnums)

Description

opts = getAnalysisOptions(fa) returns the analysis options for the active display in the Filter Analyzer app fa.

example

opts = getAnalysisOptions(fa,DisplayNums=dispnums) returns the analysis options for the displays specified in dispnums.

Examples

collapse all

Open Live Script

Design a lowpass filter, and display it in the Filter Analyzer app. 

d1 = designfilt("lowpassfir", ...
    PassbandFrequency=0.45,StopbandFrequency=0.55);
fa = filterAnalyzer(d1);

Get the analysis options of the display. Update the options so the app displays responses over a two-sided frequency range using 1024 FFT points.

opts = getAnalysisOptions(fa);
opts.NFFT = 1024;
opts.FrequencyRange = "twosided";
setAnalysisOptions(fa,opts)

Input Arguments

collapse all

Filter Analyzer app handle, specified as a filterAnalyzer object.

Display numbers, specified as an integer or a vector of integers. If you do not specify this argument, Filter Analyzer works on the active display. Use display identification numbers to target displays when using other Filter Analyzer functions. Identification numbers appear above the plotting area of the app, on the tabs that correspond to the different displays.

Example: [1 5]

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

Output Arguments

collapse all

Filter analysis options, returned as a filterAnalysisOptions object or a cell array.

  • If dispnums is a scalar or unspecified, opts is a filterAnalysisOptions object.

  • If dispnums is a vector, opts is a cell array of filterAnalysisOptions objects. opts has the same number of elements as dispnums. Each element of the cell array corresponds to the options specified for a display.

Version History

Introduced in R2024a

See Also

Apps

Objects

Functions