In the Image Labeler, Video Labeler, and Ground Truth Labeler (Automated Driving Toolbox) (requires Automated Driving Toolbox™) apps, a sublabel is a type of label for drawing regions of interest (ROIs) around objects that belong to a parent label. You can use sublabels to provide a greater level of detail about the ROIs in your labeled ground truth data. For example:
For a bird label, you can define wing or beak sublabels.
For a vehicle label, you can define headlight, licensePlate, and wheel sublabels.
A sublabel can be anything that is drawable and is part of a parent label. An attribute provides information about labels. However, attributes are not drawable and they can be associated with either a label or a sublabel.
Consider the possible sublabel and attribute candidates for the label vehicle:
A wheel is a good candidate for a sublabel. A wheel is part of a vehicle, and you can draw a label around a wheel.
Vehicle color is a good candidate for an attribute. You cannot draw a label around the color of a vehicle.
Vehicle type (car, truck, and so on) is a good
candidate for an attribute. Although you can draw a label around
cars and trucks, they are not part of a vehicle. Instead, you can define a list
attribute with types
truck, or define
logical attributes named
isTruck, and so
Within each frame, each sublabel that you draw must be associated with a parent label. Therefore, before you can draw a sublabel on a frame, you must:
From the ROI Label Definition pane, select the type of sublabel that you want to draw.
Within the frame, select a parent ROI label.
For example, to label the headlights of a vehicle, you must first select the headlight sublabel definition. On the frame, however, you cannot yet create a sublabel.
After you select a vehicle label on the frame, you can draw a sublabel that is associated with that vehicle. Once you create a sublabel, you cannot add another sublabel to the vehicle unless you select the vehicle label again.
Notice that sublabels do not have to be completely enclosed within the parent label. You can drag sublabels outside the bounds of the parent label and the parent-child relationship remains unchanged.
When labeling, it is common to copy (Ctrl+C) and paste (Ctrl+V) labels from one frame into another.
If you copy a sublabel into another frame, the parent label is copied over as well. That way, the parent-child relationship is maintained between frames. Any sublabels that you did not select to copy do not appear in the new frame.
If you copy a parent label, however, the associated sublabels are not copied over.
To delete an ROI sublabel from a frame, right-click the sublabel and select the Delete option for the sublabel shape.
To delete an ROI sublabel definition, from the ROI Label Definition pane, right-click the sublabel and select Delete.
If you delete a sublabel, all ROI sublabel annotations currently on the frames are deleted as well. Attribute definitions for that sublabel are deleted as well.
Sublabels can be used only with rectangle and polyline labels.
Sublabels cannot have their own sublabels.
The built-in automation algorithms do not support sublabel automation.
When you click View Label Summary, the Label Summary window does not display sublabel information.