addLabel

Add label to label definition creator object for multisignal workflow

Description

example

addLabel(ldc,labelName,typeOfLabel) adds a label with the specified name and type to the labelDefinitionCreatorMultisignal object ldc.

addLabel(___,Name,Value) specifies options using one or more name-value pair arguments in addition to the input arguments in the previous syntax.

Examples

collapse all

Create an empty labelDefinitionCreatorMultisignal object.

ldc = labelDefinitionCreatorMultisignal();

Add a label named 'Car'. Specify the type of label as 'Cuboid'. Adding a 'Cuboid' also adds a 'Rectangle' entry to the label definitions table.

addLabel(ldc,'Car','Cuboid');

Add another label named 'StopSign' in a group named 'TrafficSign'. Specify the type of label as a 'Rectangle'. Adding 'Rectangle' also adds a 'Cuboid' entry to the label definitions table. Add a description to the label.

addLabel(ldc,'StopSign','Rectangle','Group','TrafficSign','Description','Bounding boxes for stop signs');

Display the details of the updated labelDefinitionCreatorMultisignal object.

ldc
ldc = 
labelDefinitionCreatorMultisignal contains the following labels:

	Car with 0 sublabels and 0 attributes and belongs to None group.	(info)
	StopSign with 0 sublabels and 0 attributes and belongs to TrafficSign group.	(info)

For more details about attributes and sublabels, use the info method.

Display information about the label 'Car' using the object function info.

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

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

Display information about the label 'StopSign' using the object function info.

info(ldc,'StopSign')
           Name: "StopSign"
     SignalType: Image
      LabelType: Rectangle
          Group: "TrafficSign"
     LabelColor: {''}
     Attributes: []
      Sublabels: []
    Description: 'Bounding boxes for stop signs'

           Name: "StopSign"
     SignalType: PointCloud
      LabelType: Cuboid
          Group: "TrafficSign"
     LabelColor: {''}
     Attributes: []
      Sublabels: []
    Description: 'Bounding boxes for stop signs'

Input Arguments

collapse all

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

Label name, specified as a character vector or string scalar that uniquely identifies the label to be added.

Type of label, specified as one of these values:

  • labelType enumeration — You can use any of these labelType enumerators to specify the type of label: Cuboid, Rectangle, Line, PixelLabel, Scene, or Custom.

    Note

    Adding a Cuboid or Rectangle also adds a Rectangle or Cuboid entry, respectively, to the label definitions table.

Example: addLabel(ldc,'Car',labelType.Cuboid);

  • Character vector or string scalar — This value must partially or fully match one of the labelType enumerators.

Example: addLabel(ldc,'Car','Cub');

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: addLabel(ldc,'StopSign','Rectangle','Group','TrafficSign','Description','Bounding boxes for stop signs');

Group name, specified as a comma-separated pair consisting of 'Group' and a character vector or string scalar. Use this name-value pair to specify a name for a group of labels.

Label description, specified as a comma-separated pair consisting of 'Description' and a character vector or string scalar. Use this name-value pair to describe the label.

Introduced in R2020a