User Tools

Site Tools


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/03 17:41] – created sgrangervisual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2025/10/02 19:08] (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 groundIt 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.
  
-The command looks like this in the text editor:+==== 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**.
  
 <code> <code>
 Metric_Vector_Between_Events Metric_Vector_Between_Events
-/RESULT_METRIC_NAME=StrideVectors+/RESULT_METRIC_NAME=Stride Length
 ! /RESULT_METRIC_FOLDER=PROCESSED ! /RESULT_METRIC_FOLDER=PROCESSED
-/GENERATE_VECTOR_LENGTH_METRIC=FALSE+/GENERATE_VECTOR_LENGTH_METRIC=TRUE
 /START_SIGNAL_TYPE=KINETIC_KINEMATIC /START_SIGNAL_TYPE=KINETIC_KINEMATIC
 /START_SIGNAL_NAME=ProxEndPos /START_SIGNAL_NAME=ProxEndPos
Line 37: Line 65:
 /END_SIGNAL_TYPE=KINETIC_KINEMATIC /END_SIGNAL_TYPE=KINETIC_KINEMATIC
 /END_SIGNAL_NAME=ProxEndPos /END_SIGNAL_NAME=ProxEndPos
-/END_SIGNAL_FOLDER=RFT +/END_SIGNAL_FOLDER=LFT 
-/EVENT_SEQUENCE=RHS+RHS+/EVENT_SEQUENCE=ARM COCK START+LEAD FOOT CONTACT
 /EXCLUDE_EVENTS= /EXCLUDE_EVENTS=
 ! /GENERATE_MEAN_AND_STDDEV=TRUE ! /GENERATE_MEAN_AND_STDDEV=TRUE
Line 46: Line 74:
 </code> </code>
  
-**Note:** To get stride length, use the parameter /GENERATE_VECTOR_LENGTH_METRIC=TRUE to create the scalar of the stride vector.+==== ExampleStride Length Vector for Gait ====
  
-\\+The example below shows how **Metric Vector Between Events** can be used to create a stride length vector.
  
 +First gait events must be defined using **Automatic Gait Events**. These events are necessary as they will be referenced in the Stride Vector command:
  
-==== Example: Stride Length Vector for Throwing ====+<code> 
 +Automatic_Gait_Events 
 +! /FRAME_WINDOW=
 +! /USE_TPR=TRUE 
 +! /TPR_EVENT_INSTANCE=
 +
 +</code>
  
-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**.+Next, **Metric Vector Between Events** is used to find the vector between each right heel strike:
  
 <code> <code>
 Metric_Vector_Between_Events Metric_Vector_Between_Events
-/RESULT_METRIC_NAME=Stride Length+/RESULT_METRIC_NAME=StrideVectors
 ! /RESULT_METRIC_FOLDER=PROCESSED ! /RESULT_METRIC_FOLDER=PROCESSED
-/GENERATE_VECTOR_LENGTH_METRIC=TRUE+/GENERATE_VECTOR_LENGTH_METRIC=FALSE
 /START_SIGNAL_TYPE=KINETIC_KINEMATIC /START_SIGNAL_TYPE=KINETIC_KINEMATIC
 /START_SIGNAL_NAME=ProxEndPos /START_SIGNAL_NAME=ProxEndPos
Line 65: Line 100:
 /END_SIGNAL_TYPE=KINETIC_KINEMATIC /END_SIGNAL_TYPE=KINETIC_KINEMATIC
 /END_SIGNAL_NAME=ProxEndPos /END_SIGNAL_NAME=ProxEndPos
-/END_SIGNAL_FOLDER=LFT +/END_SIGNAL_FOLDER=RFT 
-/EVENT_SEQUENCE=ARM COCK START+LEAD FOOT CONTACT+/EVENT_SEQUENCE=RHS+RHS
 /EXCLUDE_EVENTS= /EXCLUDE_EVENTS=
 ! /GENERATE_MEAN_AND_STDDEV=TRUE ! /GENERATE_MEAN_AND_STDDEV=TRUE
Line 73: Line 108:
 ; ;
 </code> </code>
 +
 +**Note:** To get stride length, use the parameter /GENERATE_VECTOR_LENGTH_METRIC=TRUE to create the scalar of the stride vector.
 +
 +The results will look similar to this:
 +
 +{{:visual3d:documentation:pipeline:metric_commands:stridevector.png?600|}}
 +\\
  
 ==== Visual3D Versions supporting Subject Prefixes ==== ==== Visual3D Versions supporting Subject Prefixes ====
visual3d/documentation/pipeline/metric_commands/metric_vector_between_events.1720028518.txt.gz · Last modified: 2024/07/03 17:41 by sgranger