removePointValue

Remove row from point label

collapse all in page

Syntax

removePointValue(lss,midx,lblName)
removePointValue(lss,midx,lblName,'LabelRowIndex',ridx)
removePointValue(lss,midx,lblName,'SublabelRowIndex',sridx)
removePointValue(lss,midx,lblName,'LabelRowIndex',ridx,'SublabelRowIndex',sridx)

Description

removePointValue(lss,midx,lblName) removes all rows of the point label lblName for the member specified by midx.

  • If lblName is a character vector or a string scalar, the function targets a parent label.

  • If lblName is a two-element string array or a two-element cell array of character vectors, the function:

    • Interprets the first element as the name of a parent label.

    • Interprets the second element as the sublabel name of a point label.

    • Removes all the points of the sublabel.

example

removePointValue(lss,midx,lblName,'LabelRowIndex',ridx) removes a row, specified by ridx, of the point label lblName for the member midx.

If lblName is a two-element string array or a two-element cell array of character vectors, the function:

  • Interprets the first element as the name of a parent label.

  • Interprets the second element as the sublabel name of a point label.

  • Removes all the points of the sublabel contained in row ridx.

removePointValue(lss,midx,lblName,'SublabelRowIndex',sridx) removes the sublabel row specified by sridx. In this case, lblName must be a two-element string array or a two-element cell array of character vectors:

  • The first element is the name of a parent attribute label.

  • The second element is the sublabel name of a point label.

removePointValue(lss,midx,lblName,'LabelRowIndex',ridx,'SublabelRowIndex',sridx) removes the sublabel row specified by sridx of the ROI or point label row specified by ridx. In this case, lblName must be a two-element string array or a two-element cell array of character vectors:

  • The first element is the name of a parent ROI or point label.

  • The second element is the sublabel name of a point label.

Examples

collapse all

Open Live Script

Load a labeled signal set containing recordings of whale songs. Get the names of the labels and the number of members.

load whales
lss
lss = 
  labeledSignalSet with properties:

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

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


nm = lss.NumMembers;

Define a point label associated with the signal maximum.

themax = signalLabelDefinition('Maximum','LabelType','point', ...
    'LabelDataType','numeric')
themax = 
  signalLabelDefinition with properties:

                      Name: "Maximum"
                 LabelType: "point"
             LabelDataType: "numeric"
        ValidationFunction: []
    PointLocationsDataType: "double"
              DefaultValue: []
                 Sublabels: [0×0 signalLabelDefinition]
                       Tag: ""
               Description: ""

 Use labeledSignalSet to create a labeled signal set.


addLabelDefinitions(lss,themax)

Find the maxima of the signals and add their values to the labeled set.

figure
for idx = 1:nm
    sg = getSignal(lss,idx);
    [mx,ix] = max(sg);
    setLabelValue(lss,idx,'Maximum',ix,mx)
    
    subplot(nm,1,idx)
    plot((0:length(sg)-1)/lss.SampleRate,sg,ix/lss.SampleRate,mx,'*')
end

Figure contains 2 axes objects. Axes object 1 contains 2 objects of type line. One or more of the lines displays its values using only markers Axes object 2 contains 2 objects of type line. One or more of the lines displays its values using only markers

Verify that the set includes the new point label.

getLabelValues(lss)
ans=2×4 table
                 WhaleType    MoanRegions    TrillRegions      Maximum  
                 _________    ___________    ____________    ___________

    Member{1}      blue       {3×2 table}    {1×3 table}     {1×2 table}
    Member{2}      blue       {3×2 table}    {1×3 table}     {1×2 table}

Remove the 'Maximum' value for the first member of the set. Verify that the label is empty for the first member.

removePointValue(lss,1,'Maximum')

getLabelValues(lss,1)
ans=1×4 table
                 WhaleType    MoanRegions    TrillRegions      Maximum  
                 _________    ___________    ____________    ___________

    Member{1}      blue       {3×2 table}    {1×3 table}     {0×2 table}

Input Arguments

collapse all

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".

Member row number, specified as a positive integer. midx specifies the member row number as it appears in the Labels table of a labeled signal set.

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("Summit",LabelType="point") specifies a label of name "Summit" for a point of a signal in which an mountaineer reaches the summit of a mountain.

Label row index, specified as a positive integer. This argument applies only for point labels.

Sublabel row index, specified as a positive integer. This argument applies only when a label and sublabel pair has been specified in lblname and the sublabel is of type ROI or point.

Version History

Introduced in R2018b

See Also

| |