Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_cross_product [2024/07/17 15:23] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_cross_product [2025/09/18 15:17] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
 ====== Metric Cross Product ======
-Creates a cross product of two metric vectors.
+====Overview====
+The Metric Cross Product command is used to create a cross product of two metric vectors. This could include finding the torque acting on a joint or other similar uses. The command can be found within the **Pipeline Workshop** in the **Metric** folder. The command acts on the active files.
-The command acts on the active files.
+====Pipeline Command====
-{{:MetricCrossProductDlg.png}}
+The command, as seen in the pipeline workshop, is below.
 <code>
 Metric_Cross_Product
-/RESULT_METRIC_NAME=The name of the result signal
+! /RESULT_FILE=
-! /RESULT_METRIC_FOLDER=The name of the result signal folder
+! /RESULT_METRIC_FOLDER=PROCESSED
-! /METRIC1_FILE=The movement trial containing the first metric value
+/RESULT_METRIC_NAME=
-/METRIC1_NAME=The name of the metric signal to be evaluated
+! /METRIC1_FILE=
-! /METRIC1_FOLDER=The name of the metric signal folder
+! /METRIC1_FOLDER=PROCESSED
-! /METRIC2_FILE=The movement trial containing the second metric value
+/METRIC1_NAME=
-/METRIC2_NAME=The name of the metric signal folder
+! /METRIC2_FILE=
-! /METRIC2_FOLDER=The name of the metric signal folder
+! /METRIC2_FOLDER=PROCESSED
-! /DIVIDE_BY_METRIC2_LENGTH=(True or False) Divide the resulting signal by the length of the second metric
+/METRIC2_NAME=
-! /GENERATE_MEAN_AND_STDDEV=(True or False)Generate the mean and standard deviation for all of the metrics created
+! /DIVIDE_BY_METRIC2_LENGTH=TRUE
-! /APPEND_TO_EXISTING_VALUES=(True or False)Append this list of metrics to an existing metric of the same result name
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /GENERATE_VECTOR_LENGTH_METRIC=(True or False)
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /RETAIN_NO_DATA_VALUES=(True or False)
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
 </code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**METRIC1_FILE**|**The movement trial containing the first metric value**|
+|**METRIC1_NAME**|**The name of the signal containing the first metric value**|
+|**METRIC1_FOLDER**|**The name of the metric signal folder**|
+|**DIVIDE_BY_METRIC2_LENGTH**|**(True or False) Divide the resulting signal by the length of the second metric**|
+|**GENERATE_MEAN_AND_STDDEV**|**(True or False)Generate the mean and standard deviation for all of the metrics created**|
+|**APPEND_TO_EXISTING_VALUES**|**(True or False)Append this list of metrics to an existing metric of the same result name**|
+|**GENERATE_VECTOR_LENGTH_METRIC**|**(True or False)Generate metric value for vector length**|
+|**RETAIN_NO_DATA_VALUES**|**In cases where there is NO_DATA at an event, you need to specify the parameter /Retain_No_Data_Values=TRUE should you want this included in the resulting signal.**|
+====Dialog====
+The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below.
+{{:MetricCrossProductDlg.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
 === Metric_File ===
@@ Line 39: / Line 63: @@
 The results are concatenated to an existing signal.
+====Examples====
+===Simple example===
+Showing functionality of the command, using a diagram possibly to show output.
+===Complex example===
+Combine with other commands and show step-by-step process for frequent use case