HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Vector Between Events
visual3d:documentation:pipeline:metric_commands:metric_vector_between_events

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2024/07/12 14:05] – created sgrangervisual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2025/09/19 19:11] (current) – wikisysop
Line 1: Line 1:
-====== Metric_Vector_Between_Events ======+====== Metric Vector Between Events ====== 
 +====Overview====
  
-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:+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_Vector_Between_Events**                                                                     |                                                                                        |
 |**/Metric_Name=**                                                                                    |The name of the resulting metric signal.                                                | |**/Metric_Name=**                                                                                    |The name of the resulting metric signal.                                                |
Line 16: Line 43:
 |**/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|
  
-\\ +====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: The command looks like this in the text editor:
Line 49: Line 77:
  
 \\ \\
- 
- 
 ==== Example: Stride Length Vector for Throwing ==== ==== Example: Stride Length Vector for Throwing ====
  
visual3d/documentation/pipeline/metric_commands/metric_vector_between_events.1720793101.txt.gz · Last modified: 2024/07/12 14:05 by sgranger