Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_dot_product [2024/06/18 13:31] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_dot_product [2025/09/18 15:53] (current) – wikisysop
@@ Line 1: / Line 1: @@
-Creates a dot product of two metric vectors.
+====== Metric Dot Product ======
-The command acts on the active files.
+====Overview====
-{{MetricDotProductDlg.png}}
+This command creates a dot product of two metric vectors, it can be used to calculate helpful values like angles and work. The command acts on the active files. The **Metric Dot Product** command can be found in the **Pipeline Workshop** under the **Metric** folder.
-===== Command Syntax =====
+==== Pipeline Command ====
-**Metric_Dot_Product**
+<code>
-/Metric1_File=The movement trial containing the first metric value
+Metric_Dot_Product
-/Metric1_Name= The name of the metric signal to be evaluated
+! /RESULT_FILE=
-/Metric1_Folder= The name of the metric signal folder
+! /RESULT_METRIC_FOLDER=PROCESSED
-/Metric2_File= The movement trial containing the second metric value
+/RESULT_METRIC_NAME=
-/Metric2_Name= The name of the metric signal to be evaluated
+! /METRIC1_FILE=
-/Metric2_Folder= The name of the metric signal folder
+! /METRIC1_FOLDER=PROCESSED
-/Divide_By_Metric2_Length= (True or False) Divide the resulting signal by the length of the second metric
+/METRIC1_NAME=
-/Result_Metric_Name= The name of the Resulting Metric Signal
+! /METRIC2_FILE=
-/Generate_Mean_And_StdDev= (True or False)Generate the mean and standard deviation for all of the metrics created
+! /METRIC2_FOLDER=PROCESSED
-/Append_to_Existing_Values= (True or False)Append this list of metrics to an existing metric of the same result name
+/METRIC2_NAME=
-**;**
+! /DIVIDE_BY_METRIC2_LENGTH=TRUE
-==== Metric_File ====
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+! /RETAIN_NO_DATA_VALUES=FALSE
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**RESULT_FILE**|**The file type of the result**|
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**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**|
+|**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.
+{{:MetricDotProductDlg.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
+=== Metric_File ===
 If **Metric1_File** or **Metric2_File** are empty, Visual3D uses each active file when processing the command.
@@ Line 25: / Line 54: @@
 These parameters exist because the user may want to compute the dot product relative to a signal in the GLOBAL workspace or a specified file.
-==== Divide_By_Metric2_Length ====
+=== Divide_By_Metric2_Length ===
 When this is true, a unit vector of Metric2 is used.
-==== Append_to_Existing_Values ====
+=== Append_to_Existing_Values ===
 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