Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:event_commands:event_sequence_delete [2024/07/16 19:27] – created sgranger
+++ visual3d:documentation:pipeline:event_commands:event_sequence_delete [2025/04/28 19:05] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Event_Sequence_Delete ======
+====== Event Sequence Delete ======
-===== Version 6 =====
+=====Overview=====
+The `Event_Sequence_Delete` command **removes a previously defined event sequence** from the motion file.
+  * Event sequences are often used to group event pairs (e.g., LHS to LTO) into meaningful motion phases. This command allows you to cleanly remove those sequences if no longer needed or if you’re regenerating them.
+  * Use cases include cleaning up a trial before re-defining new event sequences and removing incorrect or outdated gait cycle definitions.
+  * A **requirement** is that the event sequence to be deleted must already exist, and its name must match exactly.
-**Event Sequence Delete** command will delete an event sequence. The command will only delete the series of events that were defined using the **Event Define Event Sequence** Command.
+=====Pipeline Command=====
+The pipeline command is shown below as seen in the Visual3D application.
-**Example**
-**Event_Define_Event_Sequence**\\
+<code>
-/EVENT_SEQUENCE_NAME=RSTANCE\\
+Event_Sequence_Delete
-/EVENT_SEQUENCE=RON+ROFF\\
+/EVENT_SEQUENCE_NAME=
-! /EXCLUDE_EVENTS=\\
+;
-! /INSIDE_OF_SEQUENCE=\\
+</code>
-/OFFSET_FROM_START=-1\\
-! /OFFSET_FROM_END=\\
-/OFFSET_BY=FRAMES\\
-/EVENT_SEQUENCE_INSTANCE=0\\
+=====Command Parameters=====
+The following table shows the command parameters and descriptions.
+|**Parameter**             |**Description**|
+|**/EVENT_SEQUENCE_NAME=** | The name of the event sequence you want to delete (e.g., `LeftGaitCycle`). |
+=====Dialog=====
+Due to the simplicity of this command, there is no dialog box and it can be edited within the text editor.
+=====Examples=====
+The following example shows the use of the Event_Sequence_Delete command in the Visual3D application,
+====Example 1: Delete and Redefine Sequence=====
+The functionality of this command is very straightforward. Simply type in the name of the event sequence desired to be deleted.
+In the following example, an event sequence named 'RightCycle' will be deleted and redefined afterwords.
+<code>
+Event_Sequence_Delete
+/EVENT_SEQUENCE_NAME=RightCycle
+;
+Event_Define_Event_Sequence
+/EVENT_SEQUENCE_NAME=RightCycle
+/EVENT_SEQUENCE=RHS+RTO
+/EXCLUDE_EVENTS=
+/INSIDE_OF_SEQUENCE=
+/OFFSET_FROM_START=
+/OFFSET_FROM_END=
+/OFFSET_BY=PERCENT
+/EVENT_SEQUENCE_INSTANCE=
+;
+</code>
+This removes the old `RightCycle` definition, then redefines it with a new event structure.
+====Notes====
+  * Deleting an event sequence **does not delete the events themselves**, only the sequence structure.
+  * Useful during iterative workflows where event phases are updated repeatedly.
-**Event_Sequence_Delete**\\
-/EVENT_SEQUENCE_NAME=RSTANCE