Main Content

editLabelDescription

Modify label or sublabel description in label definition creator object for multisignal workflow

Since R2020a

collapse all in page

Syntax

editLabelDescription(ldc,labelName,description)

Description

editLabelDescription(ldc,labelName,description) modifies the description of a label or sublabel identified by labelName. The label or sublabel must be associated with the labelDefinitionCreatorMultisignal object ldc.

example

Examples

collapse all

Open Live Script

Create an empty labelDefinitionCreatorMultisignal object.

ldc = labelDefinitionCreatorMultisignal;

Add a label with the name 'TrafficLight'. Specify the type of label as 'Rectangle'.

addLabel(ldc,'TrafficLight','Rectangle')

Add a sublabel called 'Light' to the label 'TrafficLight'. Specify the type of the sublabel as 'Rectangle'.

addSublabel(ldc,'TrafficLight','Light','Rectangle')

Modify Label Description

Display information about the label 'TrafficLight'.

info(ldc,'TrafficLight')
           Name: "TrafficLight"
     SignalType: Image
      LabelType: Rectangle
          Group: "None"
     LabelColor: {''}
     Attributes: []
      Sublabels: "Light"
    Description: ' '

           Name: "TrafficLight"
     SignalType: PointCloud
      LabelType: Cuboid
          Group: "None"
     LabelColor: {''}
     Attributes: []
      Sublabels: "Light"
    Description: ' '

Modify the description for the label 'TrafficLight'.

editLabelDescription(ldc,'TrafficLight','Bounding box for the traffic light')

Display information about the label 'TrafficLight' to verify the modified label description.

info(ldc,'TrafficLight')
           Name: "TrafficLight"
     SignalType: Image
      LabelType: Rectangle
          Group: "None"
     LabelColor: {''}
     Attributes: []
      Sublabels: "Light"
    Description: 'Bounding box for the traffic light'

           Name: "TrafficLight"
     SignalType: PointCloud
      LabelType: Cuboid
          Group: "None"
     LabelColor: {''}
     Attributes: []
      Sublabels: "Light"
    Description: 'Bounding box for the traffic light'

Modify Sublabel Description

Display information about the sublabel 'Light' under the label 'TrafficLight'.

info(ldc,'TrafficLight/Light')
           Name: "Light"
           Type: Rectangle
     LabelColor: ''
     Attributes: []
      Sublabels: []
    Description: ' '

Modify the description for the sublabel 'Light'.

editLabelDescription(ldc,'TrafficLight/Light','Bounding box around each light of the Traffic light')

Display information about the sublabel 'Light' under the label 'TrafficLight' to verify the modified sublabel description.

info(ldc,'TrafficLight/Light')
           Name: "Light"
           Type: Rectangle
     LabelColor: ''
     Attributes: []
      Sublabels: []
    Description: 'Bounding box around each light of the Traffic light'

Input Arguments

collapse all

Label definition creator for the multisignal workflow, specified as a labelDefinitionCreatorMultisignal object.

Label or sublabel name, specified as a character vector or string scalar that uniquely identifies the label or sublabel for which the description is to be modified.

  • To specify a label, use the form 'labelName'.

Example: editLabelDescription(ldc,'TrafficLight','Bounding box for the traffic light')

  • To specify a sublabel, use the form 'labelName/sublabelName'.

Example: editLabelDescription(ldc,'TrafficLight/Light','Bounding box around each light of the Traffic light')

Description, specified as a character vector or string scalar that contains the new description for the label or sublabel identified by labelName.

Version History

Introduced in R2020a

See Also

Objects

Functions