Main Content

addAttribute

Add attributes to label or sublabel in label definition creator object for multisignal workflow

Since R2020a

collapse all in page

Syntax

addAttribute(ldc,labelName,attributeName,typeOfAttribute,attributeDefault)
addAttribute(___,Name,Value)

Description

addAttribute(ldc,labelName,attributeName,typeOfAttribute,attributeDefault) adds an attribute with specified name and type to the indicated label or sublabel. The attribute is added under the hierarchy for the specified label or sublabel in the labelDefinitionCreatorMultisignal object ldc.

example

addAttribute(___,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

Open Live Script

Create an empty labelDefinitionCreatorMultisignal object.

ldc = labelDefinitionCreatorMultisignal;

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

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

Add an attribute 'Color' to the label 'Car'. Specify the attribute type as 'String' with the value 'Red'.

addAttribute(ldc,'Car','Color','String','Red')

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

addLabel(ldc,'TrafficLight','Rectangle','Description','Bounding boxes for stop signs');

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

addSublabel(ldc,'TrafficLight','RedLight','Rectangle');

Add an attribute 'isOn' to the sublabel 'RedLight' in the label 'TrafficLight'. Specify the attribute type for the sublabel as 'logical' with the value false.

addAttribute(ldc,'TrafficLight/RedLight','isOn','logical',false);

Display the details of the updated labelDefinitionCreatorMultisignal object.

ldc
ldc = 
labelDefinitionCreatorMultisignal contains the following labels:

	Car with 0 sublabels and 1 attributes and belongs to None group.	(info)
	TrafficLight with 1 sublabels and 0 attributes and belongs to None group.	(info)

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

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

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

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

Display information about the attribute under the label 'TrafficLight' using the object function info.

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

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

Display information about the attribute under the sublabel 'RedLight' in the label 'TrafficLight' using the object function info.

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

Display information about the attribute 'isOn' under the sublabel 'RedLight' in the label 'TrafficLight' using the object function info.

info(ldc,'TrafficLight/RedLight/isOn')
            Name: "isOn"
            Type: Logical
    DefaultValue: 0
     Description: ' '

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 to which the attribute is to be added.

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

Example: addAttribute(ldc,'Car','Color')

  • To specify a sublabel, use the form 'labelName/sublabelName'. In this case, the attribute associates with the sublabel.

Example: addAttribute(ldc,'TrafficLight/RedLight','isOn')

Attribute name, specified as a character vector or string scalar that identifies the attribute to be added to the label or sublabel.

Type of attribute, specified as one of these values:

  • attributeType enumeration — The type of the attribute must be one of these attributeType enumerators: Numeric, Logical, String, or List.

Example: addAttribute(ldc,'Car','Color',attributeType.String,'Red');

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

Example: addAttribute(ldc,'Car','Color','Str','Red');

Default value of the attribute, specified as one of these:

  • Numeric scalar — Specify this value when typeOfAttribute is Numeric.

  • Logical scalar — Specify this value when typeOfAttribute is Logical.

  • Character vector or string scalar — Specify this value when typeOfAttribute is String.

  • Cell array of character vectors or cell array of string scalars — Specify this value when typeOfAttribute is List. The first entry in the cell array is the default value.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: addAttribute(ldc,'Car/Wheel','Outsidediameter',attributeType.Numeric,740,'Description','Outside diameter in mm');

Attribute 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 attribute.

Version History

Introduced in R2020a

See Also

Objects

Functions