Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_cross_product [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_cross_product [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{creates a cross product of two metric vectors.
+====== Metric Cross Product ======
-the command acts on the active files.
+Creates a cross product of two metric vectors.
-metriccrossproductdlg.png
+The command acts on the active files.
+{{:MetricCrossProductDlg.png}}
 <code>
-metric_cross_product
+Metric_Cross_Product
-/result_metric_name=the name of the result signal
+/RESULT_METRIC_NAME=The name of the result signal
-! /result_metric_folder=the name of the result signal folder
+! /RESULT_METRIC_FOLDER=The name of the result signal folder
-! /metric1_file=the movement trial containing the first metric value
+! /METRIC1_FILE=The movement trial containing the first metric value
-/metric1_name=the name of the metric signal to be evaluated
+/METRIC1_NAME=The name of the metric signal to be evaluated
-! /metric1_folder=the name of the metric signal folder
+! /METRIC1_FOLDER=The name of the metric signal folder
-! /metric2_file=the movement trial containing the second metric value
+! /METRIC2_FILE=The movement trial containing the second metric value
-/metric2_name=the name of the metric signal folder
+/METRIC2_NAME=The name of the metric signal folder
-! /metric2_folder=the name of the metric signal folder
+! /METRIC2_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
+! /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
+! /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
+! /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_VECTOR_LENGTH_METRIC=(True or False)
-! /retain_no_data_values=(true or false)
+! /RETAIN_NO_DATA_VALUES=(True or False)
 ;
 </code>
-==== 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.
-}}