Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_time_between_events [2024/06/26 20:27] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_time_between_events [2025/09/19 13:36] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Time_Between_Events ======
+====== Metric Time Between Events ======
-Computes the time between events (or start and end of a sequence of events) as a metric.
+====Overview====
+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.
 **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 Command Details ====
+The command can be found in the **Pipeline Workshop** under **Metric**.
-Below are the details for this command:
+====Pipeline Command====
+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**                                                                       |                                                                                        |
@@ Line 17: / Line 35: @@
 |**! /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**.
@@ Line 31: / Line 59: @@
 </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.