Description

Sets the options on the autolabeler.

The autolabel operation attempts to label all the markers of the subjects in the scene for all time, selected ranges, or the current frame. When doing so, the trajectories that the autolabeler considers can be specified based on selection or length (in frames).

The autoLabelOptions command allows these options to be set as well as additional options that account for the subject calibration being less then ideal.

Functional area

Labeling

Command syntax

Syntax

autoLabelOptions [-rangeMode string] [-minTrajLength integer] [-jointPlacementSlack float] [-fixedSlack float] [-entranceThreshold float] [-exitThreshold float] [-jointLmtSlack float] [-recalSlack float] [-slackFactor float] [-selectedTraj boolean] [-solve boolean] [-labelingClusterFlexibility float] [-restoreDefaultSettings]

Arguments

None

Flags

Name	Flag arguments	Argument type	Comments
`rangeMode`	1	string	Specifies the time range the autolabeler will label.
`minTrajLength`	1	integer	Only trajectories that are this length or longer will get considered by the autolabeler.
`jointPlacementSlack`	1	float	Specifies the amount in mm the joint positions of the calibrated skeleton might be off by. Increase this value if you have low confidence in the joint positions of the skeleton.
`fixedSlack`	1	float	Specifies the amount in mm the markers positions(constraint offsets) of the calibrated skeleton might be off by. Increase this value if you have low confidence in the marker positions relative to the skeleton.
`entranceThreshold`	1	float	Specifies the percentage of markers that must get labeled for the autoalabler to consider the actor in the volume and switch from boot mode to tracking mode.
`exitThreshold`	1	float	Specifies the percentage of markers that get labeled for the autolabeler to consider the actor out of the volume.
`jointLmtSlack`	1	float	Specifies the amount in percentage to increase the joint range by. Increase this value if you think the ROM used to calibrate the skeleton did not have enough motion.
`recalSlack`	1	float	Specifies the amount in mm the marker covariance might be off by. Increase this value if you have low confidence in the maker covariances from the calibration.
`slackFactor`	1	float	This allows slight extra uncertainty in marker placement, as a proportion of the wobble observed in the subject calibration.
`selectedTraj`	1	boolean	Specifies that only selected trajectories should be considered by the autolabeler.
`restoreDefaultSettings`	0	—	Resets the autolabel options.
`labelingClusterFlexibility`		float
`solve`		boolean	Solves the labeling skeleton after automatic labeling occurs.

Return value

void

Examples

// Set the autolabeler to only label the select time ranges and not 
// allow labels applied to extend beyond the selected ranges.
autoLabelOptions -rangeMode "RangesOnly";

Additional information

Related commands

autoLabel