Description

Sets the options for the velocityLabel command.

Functional area

Labeling

Command syntax

Syntax

velocityLabelOptions [-startupError float] [-predictionError float] [-maxGap integer] [-numAvgFrames integer] [-frameByFrame boolean] [-stopOnMultiple boolean] [-continuous boolean] [-primary boolean][-reset]

Arguments

None

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`startupError`	1	float	—	Specifies the max distance in mm between the marker being labeled and other markers for it to be considered for labeling.
`predictionError`	1	float	—	Specifies the max velocity between the marker being labeled and other markers for it to be considered for labeling. Measured in mm per second.
`maxGap`	1	integer	—	Specifies the max number of frames without data the velocity labeler will continue trying to label before quitting.
`numAvgFrames`	1	integer	—	Specifies the number of frames to use when computing the average velocity of the marker we are labeling.
`frameByFrame`	1	boolean	—	Specifies if the labeler should test consider each frame or only each trajectory.
`stopOnMultiple`	1	boolean	—	Specifies if the labeler should stop when multiple solutions are present.
`continuous`	1	boolean	—	Specifies if the labeler should iterate until no more labels are made.
`primary`	1	boolean	—
`reset`	0	—	—	Resets the options to default values.

Return value

void

Examples

// Set the velocity labeler to be able to skip gaps smaller than 
// 5 frames.
velocityLabelOptions -maxGap 5;

Additional information

Related commands

velocityLabel