Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2024/06/18 13:32] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2025/09/19 19:11] (current) – wikisysop
@@ Line 1: / Line 1: @@
-This command creates a metric vector of a signal(s) value between a start and an end event. The command and it's parameters are found below:
+====== Metric Vector Between Events ======
+====Overview====
+This command creates a metric vector of a signal(s) value between a start and an end event, for example the metric vector of stride length while the foot is in contact with the ground. It can be found within the **Pipeline Workshop** under **Metric**.
+====Pipeline Command====
+The syntax for the function is as follows:
+<code>
+Metric_Vector_Between_Events
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
+/START_SIGNAL_TYPE=
+! /START_SIGNAL_FOLDER=ORIGINAL
+/START_SIGNAL_NAME=
+/END_SIGNAL_TYPE=
+! /END_SIGNAL_FOLDER=ORIGINAL
+/END_SIGNAL_NAME=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /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:
 |**Metric_Vector_Between_Events**                                                                     |                                                                                        |
 |**/Metric_Name=**                                                                                    |The name of the resulting metric signal.                                                |
@@ Line 14: / Line 43: @@
 |**/Append to Existing Values=**                                                                      |(True or False)Append this list of metrics to an existing metric of the same result name|
-\\
+====Dialog====
-The command can be edited in the text editor of the pipeline workshop or can be edited from a dialog. The dialog that pops up when pipeline selection is edited by double clicking with the left mouse button. The example below shows the dialog.
-===== Example: Stride Length Vector for Gait =====
+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.
-The dialog below contains the values for creating the Stride Length vector on the right side during gait.
+{{:MetricVectorBetweenEventsDlg.png}}
-{{MetricVectorBetweenEventsDlg.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
+==== Example: Stride Length Vector for Gait ====
 The command looks like this in the text editor:
@@ Line 47: / Line 77: @@
 \\
+==== Example: Stride Length Vector for Throwing ====
-===== Example: Stride Length Vector for Throwing =====
 A stride length vector (or scalar) can also be calculated in throwing. Events are created that define the particular phases of the throwing motion. Below is an example of calculating a stride length between **Arm Cock Start** and **Lead Foot Contact**.
@@ Line 72: / Line 100: @@
 </code>
-===== Visual3D Versions supporting Subject Prefixes =====
+==== Visual3D Versions supporting Subject Prefixes ====
 NOTE: When using events in a command, the commands will iterate across subjects contained in the current workspace. As such, events and sequences listed as command parameters should NOT contain a prefix. As each subject is processed, the event range/sequence specified will automatically use the specific events prefixed for each subject as they are processed.