HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Time Between Events
visual3d:documentation:pipeline:metric_commands:metric_time_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_time_between_events [2024/06/19 14:01] – created sgrangervisual3d:documentation:pipeline:metric_commands:metric_time_between_events [2025/09/19 13:36] (current) – 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 ====== 
 + 
 +====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]] **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**                                                                       |                                                                                        | |**Metric_Time_Between_Events**                                                                       |                                                                                        |
Line 15: Line 35:
 |**! /Append to Existing Values=FALSE**                                                               |(True or False)Append this list of metrics to an existing metric of the same result name| |**! /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**. In this example, consider the metric **Right_Terminal_Double_Limb_Support** which is the time between **LHS** and **RTO**.
  
Line 29: Line 59:
 </code> </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.
Line 42: Line 70:
 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.
Line 70: Line 98:
 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.
Line 83: Line 111:
 </code> </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.
visual3d/documentation/pipeline/metric_commands/metric_time_between_events.1718805689.txt.gz · Last modified: 2024/06/19 14:01 by sgranger