getScalarizationMethods

R2026b

Get scalarization methods for domain-specific signal features

Since R2024a

Syntax

getScalarizationMethods(sFE,featureName)

Description

getScalarizationMethods(sFE,featureName) returns the scalarization methods stored in the ScalarizationMethod property of the time-frequency feature extractor object sFE to extract scalar values from featureName.

Examples

Get Scalarization Methods for Feature Extraction

Create a signalTimeFrequencyFeatureExtractor object and enable the spectral crest, time-frequency ridges, and instantaneous bandwidth time-frequency-domain features. Specify scalarization methods in the spectral crest and the instantaneous bandwidth features.

sFE = signalTimeFrequencyFeatureExtractor( ...
    SpectralCrest=true,TFRidges=true,InstantaneousBandwidth=true);
setScalarizationMethods(sFE,"SpectralCrest", ...
    PeakValue=true,StandardDeviation=true)
setScalarizationMethods(sFE,"InstantaneousBandwidth", ...
    ImpulseFactor=true)

Get the current scalarization methods for each enabled feature.

getScalarizationMethods(sFE,"SpectralCrest")

ans = 2×1 string
    "PeakValue"
    "StandardDeviation"

getScalarizationMethods(sFE,"TFRidges")

ans = 

  0×0 empty string array

getScalarizationMethods(sFE,"InstantaneousBandwidth")

ans = 
"ImpulseFactor"

To obtain scalar features using the feature extractor object sFE, use the extract function.

Input Arguments

sFE — Feature extractor object

signalTimeFrequencyFeatureExtractor object

Feature extractor object, specified as a signalTimeFrequencyFeatureExtractor object.

featureName — Extracted feature

string scalar | character vector

Extracted feature, specified as a string scalar or a character vector.

Data Types: char | string

Tips

• Use the setScalarizationMethods function to specify scalarization methods for the features that you enabled when creating the feature extractor object.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The getScalarizationMethods function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2024a

R2026b: Use thread-based environments

You can use getScalarizationMethods in thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.