====== Event Commands Examples ======

This page will provide an overview of all the examples from the EVENT LABEL commands.

==== Automatic Gait Events ====

=== Example 1: Simple Scenario ====

The first example shows the functionality of the [[visual3d:documentation:pipeline:event_commands:automatic_gait_events|Automatic_Gait_Events]] command. After loading in your workspace containing static and dynamic trail (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>


=== Example 2: Start-to-Finish ===
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|}}

==== Event Between Examples ====