HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Automatic Gait Events
visual3d:documentation:pipeline:event_commands:automatic_gait_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:event_commands:automatic_gait_events [2025/02/13 16:24] – [Examples] wikisysopvisual3d:documentation:pipeline:event_commands:automatic_gait_events [2025/03/03 19:27] (current) – [Command Parameters] wikisysop
Line 2: Line 2:
  
 ==== Overview ==== ==== Overview ====
-Gait events describe define key moments in the walking or running cycle - such as heel-strikes and toe-offs. If [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Assignment|Force Platform assignments]] exist for a motion trial, this command __automatically detects these gait events places an **event label** at the frames of  where the subject steps ON and OFF the surface of the platform.__+Gait events describe key moments in the walking or running cycle - such as heel-strikes and toe-offs. If [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Assignment|Force Platform assignments]] exist for a motion trial, the **Automatic_Gait_Events** command __automatically detects these gait events and places an **event label** at the frames where the subject steps ON and OFF the surface of the platform.__
  
-Before running this command, the model must have segments created so that the program can recognize which is left and right. These segments are not limited to feet, they simply describe the part of body which makes contact with the force platform. +Before running this command, the model must have segments created so that the program can recognize the left from the right. These segments are not limited to feet, they simply describe the part of body which makes contact with the force platform. 
  
-Contact with the floor for which there are //no force platforms// can be determined using **Temporal Proximity Rule (TPR)**, this will be seen in the dialog box for this command. No signals need to be provided for the TPR because Visual3D uses the kinematics of the segment making contact with the force platform.+Contact with the floor for which there are //no force platforms// can be determined using **TPR**, this will be seen in the dialog box for this command. No signals need to be provided for the TPR because Visual3D uses the kinematics of the segment making contact with the force platform.
  
 ==== Pipeline Command ==== ==== Pipeline Command ====
Line 15: Line 15:
 ! /FRAME_WINDOW=8 ! /FRAME_WINDOW=8
 ! /USE_TPR=TRUE ! /USE_TPR=TRUE
 +! /TPR_EVENT_INSTANCE=1
 ;  ; 
 </code>|  </code>| 
Line 30: Line 31:
 The following table shows the command parameters for **Version 5+**. The following table shows the command parameters for **Version 5+**.
  
-|**Automatic_Gait_Events**|**Parameter Description**|+|**Parameter**|**Parameter Description**|
 |**! /FRAME_WINDOW = 8**|The frame window used for pattern recognition (default = 8)| |**! /FRAME_WINDOW = 8**|The frame window used for pattern recognition (default = 8)|
-|**! /USE_TPR=TRUE**|Enables TPR Algorithm is used to find the heelstrike (HS) and toeoff (TO).| +|**! /USE_TPR=TRUE**|Enables TPR Algorithm to be used to find the heelstrike (HS) and toeoff (TO).| 
-| **! /TPR_EVENT_INSTANCE=1**  |Instance used of detected event.|+| **! /TPR_EVENT_INSTANCE=1**  |Instances used to detect events using TPR.|
  
 ==== Dialog ==== ==== Dialog ====
Line 42: Line 43:
   * **Use Pattern Recognition to Create (L/R)HS and (L/R)TO Labels**: applies pattern recognition to identify gait cycle events.   * **Use Pattern Recognition to Create (L/R)HS and (L/R)TO Labels**: applies pattern recognition to identify gait cycle events.
   * **Frame Window for Pattern Recognition**: Number of frames used for pattern recognition   * **Frame Window for Pattern Recognition**: Number of frames used for pattern recognition
-  * **Instance of ON/OFF to use for TPR**: Determines which instance of an ON/OFF transition is used for event detection with TPR.+  * **Instance of ON/OFF to use for TPR**: Determines how many instances of an ON/OFF transition is used for event detection with TPR. 
 + 
 + 
 +==== Examples ==== 
 + 
 +The following examples will show different methods in which Automatic_Gait_Events can be used alongside other. 
 + 
 +=== Example 1 === 
 +The first example shows the functionality of the **Automatic_Gait_Events** command. After loading in your workspace containing a static and dynamic trial (with force assignments), you can simply add the command into the pipeline, which will look as follows: 
 + 
 + 
 +<code> 
 +Automatic_Gait_Events 
 +! /FRAME_WINDOW=8 
 +! /USE_TPR=TRUE 
 +! /TPR_EVENT_INSTANCE=1 
 +; 
 +</code> 
 + 
 +After executing the pipeline, you will notice a new folder in your Signals and Events tab called **EVENT_LABEL**, with all the gait events the program automatically detected. 
 + 
 +{{:visual3d:documentation:pipeline:event_commands:event_label_data_tree_new_folder.png?300|}} 
 + 
 +=== Example 2 === 
 + 
 +In the next example, the **Automatic_Gait_Events** command will be used with other commands to allow a user to go from starting with empty workspace to finding and highlighting events.  
 + 
 +  * Open the user-selected workspace file. ([[visual3d:documentation:pipeline:file_commands:file_open|File_Open]]) 
 +  * **Automatically detect gait events.**  
 +  * Iterate through and highlight all gait events. ([[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|For_Each]]) -> ([[visual3d:documentation:pipeline:other_commands:highlight_event_label|Highlight_Event_Label]]) 
 +  * Switch to Signals and Events tab, and graph X-component of Force Platform signal (events will be shown on this graph). ([[visual3d:documentation:pipeline:other_commands:switch_between_tabs|Switch_Between_Tabs]]) -> ([[visual3d:documentation:pipeline:report_commands:interactive_graph_signals|Interactive_Graph_Signals]]) 
 + 
 +The pipeline will look as follows: 
 + 
 +<code> 
 +File_Open 
 +/FILE_NAME= 
 +! /FILE_PATH= 
 +! /SEARCH_SUBFOLDERS=FALSE 
 +! /SUFFIX= 
 +! /SET_PROMPT=File_Open 
 +! /ON_FILE_NOT_FOUND=PROMPT 
 +! /FILE_TYPES_ON_PROMPT= 
 +; 
 + 
 +Automatic_Gait_Events 
 +! /FRAME_WINDOW=8 
 +! /USE_TPR=TRUE 
 +! /TPR_EVENT_INSTANCE=1 
 +; 
 + 
 + 
 +For_Each 
 +/ITERATION_PARAMETER_NAME=EVENT 
 +! /ITERATION_PARAMETER_COUNT_NAME= 
 +/ITEMS= LHS+LTO+LOFF+LON+RHS+RTO+ROFF+RON 
 +; 
 + 
 +Highlight_Event_Label 
 +/EVENT_LABEL= ::EVENT 
 +! /REMOVE_EXISTING_HIGHLIGHTS=FALSE 
 +; 
 + 
 +End_For_Each 
 +/ITERATION_PARAMETER_NAME=EVENT 
 +; 
 + 
 +Switch_Between_Tabs 
 +/SHOW_SIGNALS_AND_EVENTS_TAB=TRUE 
 +! /SHOW_WORKSPACE_TAB=FALSE 
 +! /SHOW_MODELS_TAB=FALSE 
 +; 
 + 
 +Interactive_Graph_Signals 
 +/SIGNAL_TYPES=FORCE 
 +/SIGNAL_FOLDER=ORIGINAL 
 +/SIGNAL_NAMES=FP1 
 +/SIGNAL_COMPONENTS=X 
 +/GRAPH_INDEX=1 
 +/GRAPH_SUBINDEX=1 
 +! /ZOOM_START_TIME= 
 +! /ZOOM_END_TIME= 
 +/REPLACE_CURRENT=TRUE 
 +</code> 
 + 
 +After having run this pipeline, the program is able to display the following graph:  
 +\\ 
 +{{:visual3d:documentation:pipeline:event_commands:samplegraph.png?500|}} 
 ==== Notes ==== ==== Notes ====
  
 === Gait Event Acronyms === === Gait Event Acronyms ===
-Definitions of the gait event acronyms used in Visual3D are shown below.+Definitions of gait event acronyms used in Visual3D are shown below.
  
-The automatic gait events command and many of the events created in the tutorials, and used in the example files have 3 (or 4) character labels that have been used consistently throughout history. The labels are divided into two categories:+The automatic gait events command, many of the events created in the tutorials, and events used in the example files have a 3 (or 4) character label that have been used consistently throughout history. The labels are divided into two categories:
  
-1. The kinematically based category includes:+1. Kinematic Events:
 <code> <code>
 **RHS**= Right Heel Strike **RHS**= Right Heel Strike
Line 58: Line 147:
 </code> </code>
  
-2. The kinetically based category refers to those events that describe contact with a force platforms:+2. Kinetic Events:
 <code> <code>
 **RON**= Right On **RON**= Right On
Line 94: Line 183:
 ; ;
  
-If_Condition +Conditional_Statement 
-/EXPRESSION=::FOOT == "LFT"+/ITERATION_PARAMETER_NAME=LEFT 
 +! /EXPRESSION=::FOOT == "LFT" 
 +! /AS_INTEGER=TRUE
 ; ;
     Set_Pipeline_Parameter     Set_Pipeline_Parameter
Line 113: Line 204:
     /VALUE=LTO     /VALUE=LTO
     ;     ;
-Else+     
 +Conditional_Statement_End 
 +/ITERATION_PARAMETER_NAME=LEFT 
 +; 
 + 
 +Conditional_Statement 
 +/ITERATION_PARAMETER_NAME=RIGHT 
 +! /EXPRESSION=::FOOT != "LFT" 
 +! /AS_INTEGER=TRUE
 ; ;
     ! Right foot events     ! Right foot events
Line 132: Line 231:
     /VALUE=RTO     /VALUE=RTO
     ;     ;
-End_If+Conditional_Statement_End 
 +/ITERATION_PARAMETER_NAME=RIGHT
 ; ;
  
Line 210: Line 310:
  
 **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.
- 
- 
-==== Examples ==== 
- 
-The following examples will show different methods in which Automatic_Gait_Events can be used alongside other commands for user applications. 
- 
-=== Example 1 === 
-The first example shows the functionality of the **Automatic_Gait_Events** command. After loading in your workspace containing a static and dynamic trial (with force assignments), you can simply add the command into the pipeline, which will look as follows: 
- 
- 
-<code> 
-Automatic_Gait_Events 
-! /FRAME_WINDOW=8 
-! /USE_TPR=TRUE 
-! /TPR_EVENT_INSTANCE=1 
-; 
-</code> 
- 
-After executing the pipeline, you will notice a new folder in your Signals and Events tab called **EVENT_LABEL**, within it is all of the gait events which the program automatically detected and set. 
- 
-{{:visual3d:documentation:pipeline:event_commands:event_label_data_tree_new_folder.png?300|}} 
- 
-=== Example 2 === 
- 
-In the next example, the **Automatic_Gait_Events** command will be used alongside others in a pipeline which allows the user to do the following starting from an empty project workspace: 
-  * Open the user-selected workspace file. ([[visual3d:documentation:pipeline:file_commands:file_open|File_Open]]) 
-  * **Automatically detect gait events.**  
-  * Iterate through and highlight LHS, LTO, and BTWN event labels. ([[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|For_Each]]) -> ([[visual3d:documentation:pipeline:other_commands:highlight_event_label|Highlight_Event_Label]]) 
-  * Switch to Signals and Events tab, and graph X-component of Force Platform signal (events will be shown on this graph). ([[visual3d:documentation:pipeline:other_commands:switch_between_tabs|Switch_Between_Tabs]]) -> ([[visual3d:documentation:pipeline:report_commands:interactive_graph_signals|Interactive_Graph_Signals]]) 
- 
-The pipeline will look as follows: 
- 
-<code> 
-File_Open 
-/FILE_NAME= 
-! /FILE_PATH= 
-! /SEARCH_SUBFOLDERS=FALSE 
-! /SUFFIX= 
-! /SET_PROMPT=File_Open 
-! /ON_FILE_NOT_FOUND=PROMPT 
-! /FILE_TYPES_ON_PROMPT= 
-; 
- 
-Automatic_Gait_Events 
-! /FRAME_WINDOW=8 
-! /USE_TPR=TRUE 
-! /TPR_EVENT_INSTANCE=1 
-; 
- 
- 
-For_Each 
-/ITERATION_PARAMETER_NAME=EVENT 
-! /ITERATION_PARAMETER_COUNT_NAME= 
-/ITEMS= LHS+LTO+LOFF+LON+RHS+RTO+ROFF+RON 
-; 
- 
-Highlight_Event_Label 
-/EVENT_LABEL= ::EVENT 
-! /REMOVE_EXISTING_HIGHLIGHTS=FALSE 
-; 
- 
-End_For_Each 
-/ITERATION_PARAMETER_NAME=EVENT 
-; 
- 
-Switch_Between_Tabs 
-/SHOW_SIGNALS_AND_EVENTS_TAB=TRUE 
-! /SHOW_WORKSPACE_TAB=FALSE 
-! /SHOW_MODELS_TAB=FALSE 
-; 
- 
-Interactive_Graph_Signals 
-/SIGNAL_TYPES=FORCE 
-/SIGNAL_FOLDER=ORIGINAL 
-/SIGNAL_NAMES=FP1 
-/SIGNAL_COMPONENTS=X 
-/GRAPH_INDEX=1 
-/GRAPH_SUBINDEX=1 
-! /ZOOM_START_TIME= 
-! /ZOOM_END_TIME= 
-/REPLACE_CURRENT=TRUE 
-</code> 
- 
-After having simply run this pipeline, the program is able to display the following graph:  
-\\ 
-{{:visual3d:documentation:pipeline:event_commands:samplegraph.png?500|}} 
- 
  
  
visual3d/documentation/pipeline/event_commands/automatic_gait_events.1739463887.txt.gz · Last modified: 2025/02/13 16:24 by wikisysop