Main Content

getExtractorParameters

Get current parameter values of feature extractor object

    Description

    example

    getExtractorParameters(sFE,featurename) gets the parameters used to extract featurename.

    Examples

    collapse all

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

    sFE = signalFrequencyFeatureExtractor(MeanFrequency=true,BandPower=true,PeakAmplitude=true)
    sFE = 
      signalFrequencyFeatureExtractor with properties:
    
       Properties
                  FrameSize: []
                  FrameRate: []
                 SampleRate: []
        IncompleteFrameRule: "drop"
              FeatureFormat: "matrix"
    
       Enabled Features
         MeanFrequency, BandPower, PeakAmplitude
    
       Disabled Features
         MedianFrequency, OccupiedBandwidth, PowerBandwidth, WelchPSD, 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.

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

    Data Types: char | string

    Introduced in R2021b