Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_vector_between_events [2024/06/19 12:51] – 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====
-|**metric_vector_between_events**                                                                     |                                                                                        |
+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**.
-|**/metric_name=**                                                                                    |the name of the resulting metric signal.                                                |
-|**/generate_vector_length_metric=**                                                                  |(true or false)compute the length of the vector (e.g. a scalar).                        |
-|**/start_signal_name=**                                                                              |the name of the signal whose value will be obtained from the start event.               |
-|**/start_signal_type=**                                                                              |the type of the start signal.                                                           |
-|**/end_signal_name=**                                                                                |the name of the signal whose value will be obtained from the end event.                 |
-|**/end_signal_type=**                                                                                |the type of the end signal.                                                             |
-|**/end_signal_folder=**                                                                              |the folder of the end signal.                                                           |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=**|a list of events (separated by "+" signs). for example, lhs+rto                         |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=**|exclude sequences containing these events.                                              |
-|**/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|
-\\
+====Pipeline Command====
-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 syntax for the function is as follows:
-the dialog below contains the values for creating the stride length vector on the right side during gait.
+<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>
-metricvectorbetweeneventsdlg.png
+====Command Parameters====
-the command looks like this in the text editor:
+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.                                                |
+|**/Generate_Vector_Length_Metric=**                                                                  |(TRUE or FALSE)Compute the length of the vector (e.g. a scalar).                        |
+|**/Start_Signal_Name=**                                                                              |The name of the signal whose value will be obtained from the Start Event.               |
+|**/Start_Signal_Type=**                                                                              |The type of the Start Signal.                                                           |
+|**/End_Signal_Name=**                                                                                |The name of the signal whose value will be obtained from the End Event.                 |
+|**/End_Signal_Type=**                                                                                |The type of the End Signal.                                                             |
+|**/End_Signal_Folder=**                                                                              |The folder of the End Signal.                                                           |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|Event_Sequence]]=**|A list of events (separated by "+" signs). For example, LHS+RTO                         |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|Exclude_Events]]=**|Exclude Sequences containing these Events.                                              |
+|**/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|
+====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.
+{{: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:
 <code>
-metric_vector_between_events
+Metric_Vector_Between_Events
-/result_metric_name=stridevectors
+/RESULT_METRIC_NAME=StrideVectors
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/generate_vector_length_metric=false
+/GENERATE_VECTOR_LENGTH_METRIC=FALSE
-/start_signal_type=kinetic_kinematic
+/START_SIGNAL_TYPE=KINETIC_KINEMATIC
-/start_signal_name=proxendpos
+/START_SIGNAL_NAME=ProxEndPos
-/start_signal_folder=rft
+/START_SIGNAL_FOLDER=RFT
-/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=RFT
-/event_sequence=rhs+rhs
+/EVENT_SEQUENCE=RHS+RHS
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-/append_to_existing_values=true
+/APPEND_TO_EXISTING_VALUES=TRUE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
 </code>
-**note:** to get stride length, use the parameter /generate_vector_length_metric=true to create the scalar of the stride vector.
+**Note:** To get stride length, use the parameter /GENERATE_VECTOR_LENGTH_METRIC=TRUE to create the scalar of the stride vector.
 \\
+==== 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**.
-===== 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>
-metric_vector_between_events
+Metric_Vector_Between_Events
-/result_metric_name=stride length
+/RESULT_METRIC_NAME=Stride Length
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/generate_vector_length_metric=true
+/GENERATE_VECTOR_LENGTH_METRIC=TRUE
-/start_signal_type=kinetic_kinematic
+/START_SIGNAL_TYPE=KINETIC_KINEMATIC
-/start_signal_name=proxendpos
+/START_SIGNAL_NAME=ProxEndPos
-/start_signal_folder=rft
+/START_SIGNAL_FOLDER=RFT
-/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=LFT
-/event_sequence=arm cock start+lead foot contact
+/EVENT_SEQUENCE=ARM COCK START+LEAD FOOT CONTACT
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-/append_to_existing_values=true
+/APPEND_TO_EXISTING_VALUES=TRUE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
 </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.
-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.
-}}