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 [2025/09/18 15:17] (current) – [Command Parameters] wikisysop
@@ Line 1: / Line 1: @@
-{{creates a cross product of two metric vectors.
+====== Metric Cross Product ======
-the command acts on the active files.
+====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.
-metriccrossproductdlg.png
+====Pipeline Command====
+The command, as seen in the pipeline workshop, is below.
 <code>
-metric_cross_product
+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>
-==== metric_file ====
+====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 ===
+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.
+=== Divide_By_Metric2_Length ===
+When this is true, a unit vector of Metric2 is used.
+=== Append_to_Existing_Values ===
-if **metric1_file** or **metric2_file** are empty, visual3d uses each active file when processing the command.
+The results are concatenated to an existing signal.
-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.
+====Examples====
-==== divide_by_metric2_length ====
+===Simple example===
-when this is true, a unit vector of metric2 is used.
+Showing functionality of the command, using a diagram possibly to show output.
-==== append_to_existing_values ====
+===Complex example===
-the results are concatenated to an existing signal.
+Combine with other commands and show step-by-step process for frequent use case
-}}