Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_time_between_events [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_time_between_events [2025/09/24 19:14] (current) – [Example 2 : There is always the same number of occurrences of E1 and E2] wikisysop
@@ Line 1: / Line 1: @@
-{{computes the time between events (or start and end of a sequence of events) as a metric.
+====== Metric Time Between Events ======
-**note:** in cases where the maximum event is located at the start event (time between=0), the command metric_time_between_events will not allow zero time. this is because there could be multiple instances for that event and visual 3d would not know which instance of that event to use for the calculation. a workaround can be found here [[visual3d:tutorials:pipeline:advanced_pipeline_commands#metric_time_between_events|tutorial:_advanced_command_pipeline#metric_time_between_events]]
+====Overview====
-===== metric_time_between_events command details =====
+The **Time Between Events** command computes the time between events (or start and end of a sequence of events) as a metric. For example, the command could be used to find the time a foot is in contact with the ground between Lon and Loff.
-below are the details for this command:
+**Note:** In cases where the maximum event is located at the start event (time between=0), the command metric_time_between_events will not allow zero time. This is because there could be multiple instances for that event and Visual 3D would not know which instance of that event to use for the calculation. A workaround can be found here [[Visual3D:Tutorials:Pipeline:Advanced_Pipeline_Commands#Metric_Time_Between_Events|Tutorial:_Advanced_Command_Pipeline#Metric_Time_Between_Events]]
-|**metric_time_between_events**                                                                       |                                                                                        |
+The command can be found in the **Pipeline Workshop** under **Metric**.
-|**/result_metric_name==**                                                                            |the name of the metric signal                                                           |
-|**! /result_metric_folder=processed**                                                                |the metric signal folder for the result.                                                |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#event_sequence|event_sequence]]=**|a list of events (separated by "+" signs).                                              |
-|**/[[visual3d:documentation:c3d_signal_types:event_label_data_type#exclude_events|exclude_events]]=**|this event_sequence must not be during the sequence requested.                          |
-|**! /generate_mean_and_stddev=true**                                                                 |(true or false)generate the mean and standard deviation for all of the metrics created  |
-|**! /append to existing values=false**                                                               |(true or false)append this list of metrics to an existing metric of the same result name|
-\\
+====Pipeline Command====
-in this example, consider the metric **right_terminal_double_limb_support** which is the time between **lhs** and **rto**.
+The command syntax is as follows:
+<code>
+Metric_Time_Between_Events
+/RESULT_METRIC_NAME=
+! /RESULT_METRIC_FOLDER=PROCESSED
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /SCALE_FACTOR=1
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**Metric_Time_Between_Events**                                                                       |                                                                                        |
+|**/RESULT_METRIC_NAME==**                                                                            |The name of the metric signal                                                           |
+|**! /RESULT_METRIC_FOLDER=PROCESSED**                                                                |The metric signal folder for the result.                                                |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|Event_Sequence]]=**|A list of events (separated by "+" signs).                                              |
+|**/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|Exclude_Events]]=**|This Event_Sequence must not be during the sequence requested.                          |
+|**! /Generate_Mean_And_StdDev=TRUE**                                                                 |(True or False)Generate the mean and standard deviation for all of the metrics created  |
+|**! /Append to Existing Values=FALSE**                                                               |(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.
+{{:TimeBetweenEventsDlg.png}}
+The dialog box allows you to assign values to the command parameters outlined above.
+====Examples====
+In this example, consider the metric **Right_Terminal_Double_Limb_Support** which is the time between **LHS** and **RTO**.
 <code>
-metric_time_between_events
+Metric_Time_Between_Events
-/result_metric_name=right_terminal_double_limb_support
+/RESULT_METRIC_NAME=Right_Terminal_Double_Limb_Support
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/event_sequence=lhs+rto
+/EVENT_SEQUENCE=LHS+RTO
-/exclude_events=lto+rhs
+/EXCLUDE_EVENTS=LTO+RHS
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 </code>
-below is the dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.
-timebetweeneventsdlg.png
-**note: event_sequence** - it is important to note that this command assumes that the events are specified in the correct order chronologically.
+**Note: Event_Sequence** - It is important to note that this command assumes that the events are specified in the correct order chronologically.
-for example, if the event sequence is
+For example, if the event sequence is
-e1+e2
+E1+E2
-e1 must occur before e2 or no metric signal will be created.
+E1 must occur before E2 or no metric signal will be created.
-if it is not always possible to ensure the chronological order, a series of pipeline commands may be necessary.
+If it is not always possible to ensure the chronological order, a series of Pipeline Commands may be necessary.
-===== example 1 : there is only one occurrence of e1 and e2 =====
+==== Example 1 : There is only one occurrence of E1 and E2 ====
-execute the **metric_time_between_events** twice in succession, once with the range e1+e2, then the second one with the range e2+e1 and set the option /append_to_existing_value=true on the second call.
+Execute the **Metric_Time_Between_Events** twice in succession, once with the range E1+E2, then the second one with the range E2+E1 and set the option /APPEND_TO_EXISTING_VALUE=TRUE on the second call.
 <code>
-metric_time_between_events
+Metric_Time_Between_Events
-/result_metric_name=diff
+/RESULT_METRIC_NAME=DIFF
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/event_sequence=e1+e2
+/EVENT_SEQUENCE=E1+E2
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
-metric_time_between_events
+Metric_Time_Between_Events
-/result_metric_name=diff
+/RESULT_METRIC_NAME=DIFF
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/event_sequence=e2+e1
+/EVENT_SEQUENCE=E2+E1
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-/append_to_existing_values=true
+/APPEND_TO_EXISTING_VALUES=TRUE
 ;
 </code>
-**note:** if there are multiple events, and they can occur in any sequence, then there would be no way of telling which sequence you really wanted. if this is the case, you would need to add an event in the middle of the sequence to be explicit about which sequences that you really want, such as
+**Note:** If there are multiple events, and they can occur in any sequence, then there would be no way of telling which sequence you really wanted. If this is the case, you would need to add an event in the middle of the sequence to be explicit about which sequences that you really want, such as
-e1+mid+e2, and
+E1+MID+E2, and
-e2+mid+e1
+E2+MID+E1
-===== example 2 : there is always the same number of occurrences of e1 and e2 =====
+==== Example 2 : There is always the same number of occurrences of E1 and E2 ====
-an alternative to the **metric time between events** would be to use the command **evaluate_expression**. in this case you can use **evaluate_expression** to compute the time differences between e2 and e1.
+An alternative to the **Metric Time Between Events** would be to use the command **Evaluate_Expression**. In this case you can use **Evaluate_Expression** to compute the time differences between E2 and E1.
 <code>
-evaluate_expression
+Evaluate_Expression
-/expression=event_label::original::e2-event_label::original::e1
+/EXPRESSION=EVENT_LABEL::ORIGINAL::E2-EVENT_LABEL::ORIGINAL::E1
-/result_name=diff
+/RESULT_NAME=DIFF
-/result_type=metric
+/RESULT_TYPE=METRIC
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-===== 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.
+====Example 3: Defining Events and Finding Time Between====
+Here we will create two events within a running trial, one for maximum hip flexion and another for maximum hip extension. We can then use **Metric Time Between Events** to determine how long it takes the subject to go from one event to the next for each stride.
+First we will create two new events in our pipeline, one for max left hip flexion and one for minimum left hip flexion.
+<code>
+Event_Maximum
+/RESULT_EVENT_NAME=Max_L_Hip_Flexion
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=LHipAngle
+/SIGNAL_COMPONENTS=X
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /EVENT_INSTANCE=0
+! /FRAME_WINDOW=8
+! /THRESHOLD=
+;
+Event_Minimum
+/RESULT_EVENT_NAME=Min_L_Hip_Flexion
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=LHipAngle
+/SIGNAL_COMPONENTS=X
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /EVENT_INSTANCE=0
+! /FRAME_WINDOW=8
+! /THRESHOLD=
+;
+</code>
+Now that these events have been defined we can calculate the time it takes to go from one event to the next for each instance, as well as the average time across all instances.
+<code>
+Metric_Time_Between_Events
+/RESULT_METRIC_NAME=L_Hip_Flexion_Time
+! /RESULT_METRIC_FOLDER=PROCESSED
+/EVENT_SEQUENCE=Min_L_Hip_Flexion+Max_L_Hip_Flexion
+/EXCLUDE_EVENTS=
+! /SCALE_FACTOR=1
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+Once the pipeline has been executed two new folders should appear containing the calculated time values and the average value across all instances.
+{{:visual3d:documentation:pipeline:metric_commands:flexion_time.png?400|}}{{:visual3d:documentation:pipeline:metric_commands:flexion_time_mean.png?400|}}
+==== 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.
-}}