removeLabelDefinition

Remove label definition from labeled signal set

Since R2018b

Syntax

removeLabelDefinition(lss,lblname)

Description

removeLabelDefinition(lss,lblname) removes the label definition lblname from the labeled signal set lss. If you want to remove a sublabel, specify lblname as a two-element string array or two-element cell array of character vectors:

The first element is the name of the parent label.
The second element is the name of the sublabel.

Examples

collapse all

Remove Label Definition

Open Live Script

Load a labeled signal set containing recordings of whale songs.

load whales
lss

lss = 
  labeledSignalSet with properties:

             Source: {2x1 cell}
         NumMembers: 2
    TimeInformation: "sampleRate"
         SampleRate: 4000
             Labels: [2x3 table]
        Description: "Characterize wave song regions"

 Use labelDefinitionsHierarchy to see a list of labels and sublabels.
 Use setLabelValue to add data to the set.

Retrieve a hierarchical list of labels and sublabels.

labelDefinitionsHierarchy(lss)

ans = 
    'WhaleType
       Sublabels: []
     MoanRegions
       Sublabels: []
     TrillRegions
       Sublabels: TrillPeaks
     '

Remove the sublabel that labels peaks in the trill regions.

removeLabelDefinition(lss,{'TrillRegions' 'TrillPeaks'})

labelDefinitionsHierarchy(lss)

ans = 
    'WhaleType
       Sublabels: []
     MoanRegions
       Sublabels: []
     TrillRegions
       Sublabels: []
     '

Remove the label that specifies the whale type.

removeLabelDefinition(lss,"WhaleType")

getLabelNames(lss)

ans = 2x1 string
    "MoanRegions"
    "TrillRegions"

Input Arguments

collapse all

`lss` — Labeled signal set
`labeledSignalSet` object

Labeled signal set, specified as a labeledSignalSet object.

Example: labeledSignalSet({randn(100,1) randn(10,1)},signalLabelDefinition('female')) specifies a two-member set of random signals containing the attribute 'female'.

`lblname` — Label or sublabel name
character vector | string scalar | cell array of character vectors | string array

Label or sublabel name. To specify a label, use a character vector or a string scalar. To specify a sublabel, use a two-element cell array of character vectors or a two-element string array:

The first element is the name of the parent label.
The second element is the name of the sublabel.

Example: signalLabelDefinition("Asleep",'LabelType','roi') specifies a label of name "Asleep" for a region of a signal in which a patient is asleep during a clinical trial.

Example: {'Asleep' 'REM'} or ["Asleep" "REM"] specifies a region of a signal in which a patient undergoes REM sleep.