HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Explicit
visual3d:documentation:pipeline:event_commands:event_explicit

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:event_explicit [2025/02/19 16:54] – wikisysopvisual3d:documentation:pipeline:event_commands:event_explicit [2025/02/20 20:08] (current) – [Examples] wikisysop
Line 16: Line 16:
 ; ;
 </code> </code>
 +
 +==== Command Parameters ====
 +The following table shows the command parameters and descriptions:
 +
 +|**Parameter**|**Description**|
 +|**/EVENT_NAME=**|Specifies the name of the event being created.|
 +|**! /FRAME=**| Defines the frame at which the event occurs.|
 +|**! /TIME=**|Defines the exact time (in seconds) at which the event occurs.|
 +
 +==== 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. 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.
  
-{{:ExplicitEventDlg.jpg}}+{{:visual3d:documentation:pipeline:event_commands:event_explicit_dialog_box.png?400|}}
  
-=== Example: Specify an event based on a metric ===+In this dialog, the user is given the options to name the event, and specify either a frame or time to create the event label. 
 +==== Examples ==== 
 +The following examples will go through the use of the **Event_Explicit** command in the Visual3D application. 
  
-Here are two examples of creating explicit events based on metrics for frames and time.+=== Example 1: Simple Use Case === 
 +In the first example, let's say the user knows the specific time when the subject's left foot comes in contact with the ground in a walking trial, at the time of 1.25 seconds.
  
-This example will place an event at the frame metric TEST_FRAME+Here is how the command would be defined in the pipeline:
  
 <code> <code>
 Event_Explicit Event_Explicit
-/Event_Name= TEST +/EVENT_NAME= LEFT_FOOT_CONTACT 
-/Frame= METRIC::PROCESSED::TEST_FRAME +! /FRAME= 
-! /Time= +/TIME= 1.25
-;+
 </code> </code>
  
-This example will place an event at the time metric TEST_TIME+In the dataset used for this example, 1.25 seconds represents the exact point when contact is made, this is can be seen clearly by the graph produced with the highlighted event label.
  
-<code> +{{:visual3d:documentation:pipeline:event_commands:graph_example1.png?400|}}
-Event_Explicit +
-/Event_Name= TEST +
-/Frame=  +
-/Time=METRIC::PROCESSED::TEST_TIME +
-; +
-</code>+
  
-=== Example: Create events at the start and end of the trial: ===+=== Example 2: Create events using the START and END of trial === 
 +The following command will create an event label named 'START' at the first frame of the trial.
  
 <code> <code>
Line 55: Line 62:
 </code> </code>
  
-[[Visual3D:Documentation:Definitions:EOF_(End_of_File)|EOF]] is now recognized as the last frame in the file, and the minus sign can be used.+The next **Event_Explicit** command will create an event labelled 'END' placed on the last frame of data, in some cases, the user may not know how many frames there are, which is why [[Visual3D:Documentation:Definitions:EOF_(End_of_File)|EOF]] is used to recognize the last frame in the file.
  
 <code> <code>
Line 65: Line 72:
 </code> </code>
  
-=== Example: Create an event 10 frames before the end of the trial: === +When creating an event a certain number of frames offset from the [[Visual3D:Documentation:Definitions:EOF_(End_of_File)|EOF]], a minus (-) sign can be used to specify how many frames before the End of File that the desired event takes place.
- +
-[[Visual3D:Documentation:Definitions:EOF_(End_of_File)|EOF]] is now recognized as the last frame in the file, and the minus sign can be used.+
  
 <code> <code>
 Event_Explicit Event_Explicit
-/Event_Name= TEST+/Event_Name= EOF_MINUS_10
 /Frame= EOF - 10 /Frame= EOF - 10
 /Time= /Time=
Line 77: Line 82:
 </code> </code>
  
-=== Example: Create an event at multiple frames ===+This graph shows that the event labels were placed in the desired locations.
  
-Introduced in Version 6 +{{:visual3d:documentation:pipeline:event_commands:graph_example2.png?500|}}
-\\+
  
 +=== Example 3: Create an event at multiple frames ===
 +
 +This functionality was introduced into the command in **Version 6**. It will create three instances of the event label 'TEST' at frames 1, 5 and 10:
  
 <code> <code>
Line 91: Line 98:
 </code> </code>
  
-This command will create three instances of the EVENT_LABEL TEST at frames 1, 5, and 10 
  
-=== Example: Create an event at one second intervals ===+=== Example 4: Create an event at one second intervals === 
 +This final example represents the **Event_Explicit** command used within a loop in order to create an event at one second intervals throughout the file.
  
-! Determine the number of ranges +<code> 
-! For some files this might be 1 too many but it won't matter. +Set_Pipeline_Parameter_From_For_Loop
-**Set_Pipeline_Parameter_From_For_Loop**+
 /PARAMETER_NAME=COUNT /PARAMETER_NAME=COUNT
 /PARAMETER_INDEX_START=1 /PARAMETER_INDEX_START=1
Line 103: Line 109:
 /PARAMETER_INDEX_STEP=1 /PARAMETER_INDEX_STEP=1
 ! /PARAMETER_INDEX_TYPE=INTEGER ! /PARAMETER_INDEX_TYPE=INTEGER
-**;** +; 
-! execute a For_Each loop + 
-**For_Each**+For_Each
 /ITERATION_PARAMETER_NAME=INDEX /ITERATION_PARAMETER_NAME=INDEX
 ! /ITERATION_PARAMETER_COUNT_NAME= ! /ITERATION_PARAMETER_COUNT_NAME=
 /ITEMS=::COUNT /ITEMS=::COUNT
-**;** +; 
-**Event_Explicit**+ 
 +Event_Explicit
 /EVENT_NAME=TEST /EVENT_NAME=TEST
 ! /FRAME= ! /FRAME=
 /TIME=::INDEX /TIME=::INDEX
-**;** +; 
-**End_For_Each**+ 
 +End_For_Each
 /ITERATION_PARAMETER_NAME=INDEX /ITERATION_PARAMETER_NAME=INDEX
-**;**+; 
 +</code>
  
  
visual3d/documentation/pipeline/event_commands/event_explicit.1739984093.txt.gz · Last modified: 2025/02/19 16:54 by wikisysop