Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:signal_commands:compute_ik_residuals [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:compute_ik_residuals [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-===== command =====
+====== Compute IK Residuals ======
+==== Command ====
 <code>
-compute_ik_residuals
+Compute_IK_Residuals
-! /result_folder=ik_target_residuals
+! /RESULT_FOLDER=IK_TARGET_RESIDUALS
-! /separate_components=false
+! /SEPARATE_COMPONENTS=FALSE
 ;
 </code>
-a signal equal to the inverse kinematic target residual will be created for every target in your ik model. the results will be under the type derived.
+A signal equal to the inverse Kinematic target residual will be created for every target in your IK model. The results will be under the type DERIVED.
-separate_components is a hidden parameter by default. if separate_components is included and is set to true, a separate signal will be created for each of the x y and z components. (an _x, _y or _z will be appended to the target name depending on the component).
+SEPARATE_COMPONENTS is a hidden parameter by default. If SEPARATE_COMPONENTS is included and is set to TRUE, a separate signal will be created for each of the X Y and Z components. (An _X, _Y or _Z will be appended to the target name depending on the component).
-note: to guarantee that the model pose is consistent with the current ik properties a "build_model" or "recalc" should be run right before the compute_ik_residuals.
+Note: To guarantee that the model pose is consistent with the current IK Properties a "Build_Model" or "RECALC" should be run right before the Compute_IK_Residuals.
-===== background =====
+==== Background ====
-this command can be used to calculate the residual for each target when using inverse kinematics is used to compute the segment pose. the residual is the euclidean distance between the target's expected location (obtained by transforming the fixed local coordinates of a target from segment space to lab space) and the measured location of the target by the motion capture system. the ik residuals tell the users which targets contribute the largest error to the ik fit.
+This command can be used to calculate the residual for each target when using Inverse Kinematics is used to compute the segment Pose. The residual is the Euclidean distance between the target's expected location (obtained by transforming the fixed local coordinates of a target from segment space to lab space) and the measured location of the target by the motion capture system. The IK residuals tell the users which targets contribute the largest error to the IK fit.
-an example of when this would be useful is if you have an ik model and some issues seem to be appearing. you can calculate the residuals for the targets in your ik. if one target as a higher residual than the other targets in your model, you may want to consider removing this target from the list of tracking targets.
+An example of when this would be useful is if you have an IK model and some issues seem to be appearing. You can calculate the residuals for the targets in your IK. If one target as a higher residual than the other targets in your model, you may want to consider removing this target from the list of tracking targets.