Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_dot_product [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_dot_product [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{creates a dot product of two metric vectors.
+====== Metric Dot Product ======
-the command acts on the active files.
+Creates a dot product of two metric vectors.
-metricdotproductdlg.png
+The command acts on the active files.
-===== command syntax =====
+{{:MetricDotProductDlg.png}}
-**metric_dot_product**
+==== Command Syntax ====
-/metric1_file=the movement trial containing the first metric value
-/metric1_name= the name of the metric signal to be evaluated
+**Metric_Dot_Product**
-/metric1_folder= the name of the metric signal folder
+/Metric1_File=The movement trial containing the first metric value
-/metric2_file= the movement trial containing the second metric value
+/Metric1_Name= The name of the metric signal to be evaluated
-/metric2_name= the name of the metric signal to be evaluated
+/Metric1_Folder= The name of the metric signal folder
-/metric2_folder= the name of the metric signal folder
+/Metric2_File= The movement trial containing the second metric value
-/divide_by_metric2_length= (true or false) divide the resulting signal by the length of the second metric
+/Metric2_Name= The name of the metric signal to be evaluated
-/result_metric_name= the name of the resulting metric signal
+/Metric2_Folder= The name of the metric signal folder
-/generate_mean_and_stddev= (true or false)generate the mean and standard deviation for all of the metrics created
+/Divide_By_Metric2_Length= (True or False) Divide the resulting signal by the length of the second metric
-/append_to_existing_values= (true or false)append this list of metrics to an existing metric of the same result name
+/Result_Metric_Name= The name of the Resulting Metric Signal
+/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
 **;**
-==== metric_file ====
+=== Metric_File ===
+If **Metric1_File** or **Metric2_File** are empty, Visual3D uses each active file when processing the command.
-if **metric1_file** or **metric2_file** are empty, visual3d uses each active file when processing the command.
+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.
-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.
-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.
-the results are concatenated to an existing signal.
-}}