This information is for Vicon Shogun 1.7. For up-to-date help, see the latest Shogun documentation.

Vicon Shogun banner


Autolabels trajectories

Autolabeling is Shogun's default automated mechanism to assign unlabeled markers to the markers of a calibrated character. Autolabeling examines the positions of unlabeled markers in the frame and attempts to fit them to the marker sets of the characters loaded into the scene, based on the relative distances between marker pairs. The autoLabel command autolabels trajectories based on the frame range specified by the rangeMode option.

Labeling selected ranges requires specifying whether the labeling of markers will extend beyond the selected ranges, since trajectory lifetimes may extend beyond the specified start and end times of the selected ranges.

If extending the labeling to frames outside the selected ranges is desired, use the selectedranges mode; otherwise, use the selectedrangesonly mode, which will break the trajectories where they cross the start and end of the selected ranges.

rangeMode optionDescription
playrangeAutolabel over the entire play range
selectedrangesAutolabel over selected ranges and extend labels to labeled trajectories beyond range of selection
selectedrangesonlyAutolabel over selected ranges only within the frames within the selected ranges, breaking trajectories
currentframeAutolabels the current frame without breaking trajectories

Functional area


Command syntax


autoLabel [-rangeMode string]




NameFlag argumentsArgument typeExclusive toComments
rangeMode1stringSet the range mode of the autolabel operation to one of the following values:
playrange Autolabel the frames contained in the entire play range
selectedranges Autolabel only the selected frames, extending labels to the entire trajectory including to frames outside the selected ranges
selectedrangesonly Autolabel the selected frames, and do not extend application of labeling beyond the selected ranges, breaking trajectories if necessary
currentframe Autolabel the trajectories in the current frame without breaking them

Return value



// Autolabel the entire play range.
autoLabel -rangeMode "playRange";

Additional information

Related commands