Description

Finds and selects keys that deviate over a tolerance between the active clip and another clip. Both clips must have a key at each frame for the comparison to be done.

This is useful when comparing the results of an editing operation with the second figure clip.

Functional area

Data retrieval

Command syntax

Syntax

findDeviantKeys compareClip tolerance length [-ranges] [-primaryOnly] [-selectRanges] [-noFeedback] [-positionOnly] [-rotationOnly]

Arguments

Name	Type	Required	Comments
`compareClip`	string	yes	Name of the clip to compare with.
`tolerance`	float	yes	Value in millimeters that key values must be deviant to be selected.
`length`	integer	yes	Number of consecutive frames that keys must be deviant to be selected.

Flags

Name	Argument type	Exclusive to	Comments
`ranges`	—	—	Restricts the search to the selected time ranges. The default is to search the entire animation range.
`primaryOnly`	—	—	Restricts the search to the primary selected node. The default is to search all selected nodes.
`selectRanges`	—	—	Specifies that the ranges of the deviant keys should be selected as well.
`noFeedback`	—	—	Set this flag to skip writing the results of the operation to the log
`positionOnly`	—	primaryOnly, selectRanges	Check position deviance only, ignoring rotational deviance
`rotationOnly`	—	ranges, selectRanges	Check rotational deviance only, ignoring positional deviance

Return value

integer

Returns the number of deviant keys

Examples

// Import a file and create a second figure
loadFile "C:/temp/myFile.c3d" -i -createSecondFig;
 
// Select and filter the head markers using the current filter settings
select LFHD RFHD LBHD RBHD;
selectRange -all;filter;
 
// Now select the keys that deviate from the second figure clip
// by at least 5 mm over at least 10 consecutive keys. Also select the deviant ranges. 
findDeviantKeys myFilec3d_2fg 5 10 -selectRanges;
// Do something with those keys/ranges!

Shogun 1.9 Documentation

findDeviantKeys