showSpecificationMask

Show or hide filter specification mask in Filter Analyzer app

Since R2024a

collapse all in page

Syntax

showSpecificationMask(fa,showit)
showSpecificationMask(___,DisplayNums=dispnums)

Description

showSpecificationMask(fa,showit) shows or hides the filter specification mask on the active display in the Filter Analyzer app fa, depending on whether showit is true or false, respectively. For the app to show a mask:

  • There must be only one filter plotted in the display.

  • The filter must contain design metadata. To include metadata in your design, use a digitalFilter object or a filter System object™.

  • You must specify the Analysis argument of fa as either "magnitude" or "magestimate". You must not specify an overlaid analysis.

example

showSpecificationMask(___,DisplayNums=dispnums) shows or hides the specification mask on the displays specified in dispnums, in addition to the input arguments from the previous syntax.

Examples

collapse all

Open Live Script

Design a lowpass filter and display it in Filter Analyzer.

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

Hide the specification mask.

showSpecificationMask(fa,false)

Input Arguments

collapse all

Filter Analyzer app handle, specified as a filterAnalyzer object.

Show option, specified as a logical 0 (false) or 1 (true).

Data Types: logical

Displays on which to toggle the specification mask, specified as an integer or a vector of integers. If you do not specify this argument, Filter Analyzer toggles the specification mask in the active display. 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

Version History

Introduced in R2024a

See Also

Apps

Objects

Functions