HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Event Delete =====

==== Overview ====
The **Event_Delete** command is used to remove an existing event from a dataset based on specified conditions. This command allows users to delete all instances of an event, target specific occurrences, or limit deletions within a defined event sequence while optionally excluding specific events. Users can also delete events based on a time reference.

This command is particularly useful for refining datasets by removing redundant, incorrectly placed, or unnecessary events, ensuring accuracy i n biomechanical event analysis.

The functionality of this command can also be achieved by right-clicking on an event in the data tree, **Delete Event** us an option on the context menu. The interactive selection from the data tree can be shown here:

{{:visual3d:documentation:pipeline:event_commands:eventdelete_interactive_selection.png?300|}}

==== Pipeline Command ====
The command below is as seen in the Visual3D application.

<code>
Event_Delete
/EVENT_NAME=
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
! /EVENT_INSTANCE=
! /TIME=
;
</code>

==== Command Parameters ====
The following table shows the command parameters and descriptions:

|**Parameter**       |**Description**     |
|**/EVENT_NAME**|The name of the event to be deleted.|
|**!/EVENT_SEQUENCE**|Specifies a sequence of events within deletion occurs. Only events within this sequence will be considered for deletion.|
|**!/EXCLUDE_EVENTS=**|Defines events that should not be deleted within the specified sequence.|
|**!/EVENT_INSTANCE=**|Specifies which instance of the event should be deleted. A value of 0 deletes all occurrences, while positive or negative numbers select specific instances.|
|**!/TIME**|Deletes events that occur at a specific time.|

==== Dialog ====
Due to the simplicity of this command and the interactive selection option, this command does not display a dialog box when clicked, instead parameters can be edited within the text editor.

==== Examples ====
The following examples will go through the use of the **Event_Delete** command in the Visual3D application.

=== Example 1: Deleting All Instances of an Event ===
The first example shows the process of removing the "OFF" and "ON" events for each foot during a gait cycle, which leaves only HS (heel strike) and TO (toe off) events, determined by the Automatic_Gait_Events command.

After running the Automatic_Gait_Events command as shown below, the EVENT_LABEL folder will be created housing all of the events:

<code>
Automatic_Gait_Events
! /FRAME_WINDOW=8
! /USE_TPR=TRUE
! /TPR_EVENT_INSTANCE=1
;
</code>


{{:visual3d:documentation:pipeline:event_commands:events_list.png?200|}}

Then, we can use the **For_Each** command to iterate through each of the events we want to delete, and the **Event_Delete** command to actually delete.

<code>
For_Each
/ITERATION_PARAMETER_NAME=EVENT
! /ITERATION_PARAMETER_COUNT_NAME=
/ITEMS=LON+LOFF+RON+ROFF
;

Event_Delete
/EVENT_NAME=::EVENT
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
! /EVENT_INSTANCE=
! /TIME=
;

End_For_Each
/ITERATION_PARAMETER_NAME=EVENT
;
</code>

{{:visual3d:documentation:pipeline:event_commands:events_list_updated.png?300|}}

=== Example 2: Deleting a Specific Instance of an Event ===
In this example, imagine analyzing a gait cycle where a participant takes two steps with their right foot and then two steps with their left foot.

If primarily interested in analyzing the first step taken with each foot, in this situation, only the second instance of toe-off for each foot should be deleted.

<code>
Event_Delete
/EVENT_NAME=LTO
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
/EVENT_INSTANCE=2
! /TIME=
;

Event_Delete
/EVENT_NAME=RTO
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
/EVENT_INSTANCE=2
! /TIME=
;
</code>