getExtractorParameters

Get current parameter values of feature extractor object

Since R2021b

collapse all in page

    Syntax

    getExtractorParameters(sFE,featureName)

    Description

    getExtractorParameters(sFE,featureName) returns the current values of all the parameters of the feature specified in featureName.

    example

    Examples

    collapse all

    Open Live Script

    Create a signalFrequencyFeatureExtractor object and enable the mean frequency, band power, and peak amplitude features.

    sFE = signalFrequencyFeatureExtractor(MeanFrequency=true, ...
    BandPower=true,PeakAmplitude=true,WelchPSD=true)
    sFE = 
  signalFrequencyFeatureExtractor with properties:

   Properties
              FrameSize: []
              FrameRate: []
             SampleRate: []
    IncompleteFrameRule: "drop"
          FeatureFormat: "matrix"
    ScalarizationMethod: [1×1 frequencyScalarFeatureOptions]

   Enabled Features
     MeanFrequency, BandPower, WelchPSD, PeakAmplitude

   Disabled Features
     MedianFrequency, OccupiedBandwidth, PowerBandwidth, PeakLocation

    Get the current parameters for the peak amplitude. Note that not all features have parameters for feature computation.

    params = getExtractorParameters(sFE,'PeakAmplitude')
    params = struct with fields:
         PeakType: "maxima"
    MaxNumExtrema: 1
    MinProminence: []
    MinSeparation: []
    FlatSelection: []

    You can also modify feature parameters. Set the maximum number of peaks to 2 and the minimum peak separation to 3 samples.

    params.MaxNumExtrema = 2;
params.MinSeparation = 3
    params = struct with fields:
         PeakType: "maxima"
    MaxNumExtrema: 2
    MinProminence: []
    MinSeparation: 3
    FlatSelection: []

    Input Arguments

    collapse all

    Feature extractor object, specified as a signalFrequencyFeatureExtractor object or a signalTimeFrequencyFeatureExtractor object.

    Name of feature, specified as a string scalar or a character vector.

    Specify featureName based on the feature extractor object specified in sFE.

    • If you specify sFE as a signalFrequencyFeatureExtractor object, specify featureName as one of these: "OccupiedBandwidth", "PowerBandwidth", "PeakAmplitude", "PeakLocation", or "WelchPSD".

    • If you specify sFE as a signalTimeFrequencyFeatureExtractor object, specify featureName as one of these:

      • Time-frequency analysis methods: "spectrogram", "synchrosqueezedspectrogram", "emd", "vmd", "scalogram", "synchrosqueezedscalogram", "wavelet", or "waveletpacket".

      • Time-frequency features: "SpectralEntropy", "TFRidges", "InstantaneousBandwidth", "InstantaneousFrequency", "InstantaneousEnergy", "WaveletEntropy", "TimeSpectrum", or "ScaleSpectrum".

    Data Types: char | string

    Tips

    • Use the setExtractorParameters function to specify parameters to use when extracting the features that you enabled when creating the feature extractor object.

    Version History

    Introduced in R2021b

    See Also

    Objects

    Functions