Differences

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

--- visual3d:documentation:pipeline:event_commands:event_rename [2024/06/19 13:59] – created sgranger
+++ visual3d:documentation:pipeline:event_commands:event_rename [2025/04/29 14:25] (current) – [Dialog] wikisysop
@@ Line 1: / Line 1: @@
-To **Rename** an event label, you can use a pipeline command or you can select the event in the data tree using the right mouse button.
+====== Event Rename ======
+===== Overview =====
+The **Event_Rename** command is used to rename an existing event while optionally defining event sequences, excluding specific events, or selecting particular event instances. The command is useful when standardizing event names for consistency across datasets or refining event definitions within specific motion analysis workflows.
-===== Interactive selection from the data tree: =====
+The functionality of this command can also be achieved by right-clicking on an event in the data tree, **Rename Event** is an option on the context menu. The interactive selection from the data tree can be shown here.
-{{RenameEventDlg.jpg}}]
+{{:visual3d:documentation:pipeline:event_commands:rename_contextmenu_option.png?300|}}
-{{RenameEventSmall.jpg}}
-===== From the Edit Events Dialog =====
-{{EditEventsDlg.jpg}}
+===== Pipeline Command =====
-===== Pipeline command: =====
+The command below is as seen in the Visual3D application.
-**Event_Rename**
+<code>
-/Event_Name= The name of the original event
+Event_Rename
-/New_Event_Name= The name to be given to the **new event**
+/EVENT_NAME=
-/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Sequence|Event_Sequence]]= Sequence of Events that defines the ranges
+/NEW_EVENT_NAME=
-/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Exclude_Events|Exclude_Events]]= An inclusive Event that excludes the range
+! /EVENT_INSTANCE=0
-/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Instance|Event_Instance]]= The instance of the existing event to copy.
+! /RANGE_INSTANCE=0
-/[[Visual3D:Documentation:C3D_Signal_Types:EVENT_LABEL_Data_Type#Event_Instance|Range_Instance]]= The instance of the existing event to copy.
+! /EVENT_SEQUENCE=
-**;**
+! /EXCLUDE_EVENTS=
-===== Event_Rename Dialog =====
+;
+</code>
-{{CopyEventLabelDlgEx1.jpg}}
+===== Command Parameters =====
-===== Event Instance =====
+The following table shows the command parameters and descriptions:
-Event_Instance=0 -> copy all instances of the Event
+|**Parameters**     |**Description**|
+|**/EVENT_NAME=**| The name of the **existing event**.|
+|**/NEW_EVENT_NAME=**|The name assigned to the newly created event.|
+|**!/EVENT_INSTANCE=0**|Specifies which instance of the event should be renamed. A value of 0 renames all occurrences, while positive or negative numbers select specific instances.|
+|**!/RANGE_INSTANCE=0**|Instance of the range used for renaming.|
+|**!/EVENT_SEQUENCE=**|Defines a sequence of events that specifies the range for renaming.|
+|**!/EXCLUDE_EVENTS=**|Inclusive event that excludes the specified range.|
-Event_Instance=n -> copy the nth instance of the Event
+==== 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.
-if n<1 count instances from the last Event; e.g. -1 = last instance
+{{:visual3d:documentation:pipeline:event_commands:rename_dialog.png?400|}}
-===== Range Instance =====
+  * **Event to Rename**: Name of the existing event to be changed.
+  * **New Event Label Name**: New name to assign to the selected event.
+  * **Find Event Within Range**: Define start and end of event range.
+  * **Range Instance**: Determine number of ranges to evaluate.
+  * **Event Instance**: Which occurrence of the event to be renamed. If 'Interpret Event Instance As List' is checked, this allows multiple specific event instances to be selected (e.g. 1,3,5)
-Range_Instance=0 -> use all instances of the Range
+===== Examples =====
+The following examples will go through the use of the Event_Rename command in the Visual3D application.
-Range_Instance=n -> use the nth instance of the Range
+==== Example 1: Basic Gait Event Rename ====
+In this first example, the simple gait event of Right Heelstrike (RHS), found with the **Automatic_Gait_Events** command will be renamed to "Right Foot Contact" (RFC).
-if n<1 count instances from the last Range; e.g. -1 = last range
+The first step is to identify the gait event needed:
-===== Example =====
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+</code>
-In this example, the last event instance in the first range of the event sequence START+START is renamed.
+Next, we can apply the Event_Rename command in order to rename the RHS event:
-{{EventRenameExampleDlg.jpg}}
+<code>
-**Event_Rename**
+Event_Rename
-/EVENT_NAME=TEST
+/EVENT_NAME=RHS
-/NEW_EVENT_NAME=NEWTEST
+/NEW_EVENT_NAME=RFC
-/EVENT_INSTANCE=-1
+! /EVENT_INSTANCE=0
-/RANGE_INSTANCE=1
+! /RANGE_INSTANCE=0
-/EVENT_SEQUENCE=START+START
+! /EVENT_SEQUENCE=
 ! /EXCLUDE_EVENTS=
-**;**
+;
+</code>
+Now that this pipeline has been applied, the Event Label folder will reflect this change:
+{{:visual3d:documentation:pipeline:event_commands:renamed_event.png?300|}}
+==== Example 2: Renaming an Event Within a Sequence ====
+In this example, the **Event_Rename** command is used to rename an event within the event sequence "Gait Cycle".
+<code>
+Automatic_Gait_Events
+! /FRAME_WINDOW=8
+! /USE_TPR=TRUE
+! /TPR_EVENT_INSTANCE=1
+;
+Event_Define_Event_Sequence
+/EVENT_SEQUENCE_NAME=Gait Cycle
+/EVENT_SEQUENCE=LHS+LTO+RHS+RTO
+! /EXCLUDE_EVENTS=
+! /INSIDE_OF_SEQUENCE=
+! /OFFSET_FROM_START=
+! /OFFSET_FROM_END=
+! /OFFSET_BY=PERCENT
+/EVENT_SEQUENCE_INSTANCE=0
+;
+Event_Rename
+/EVENT_NAME=LHS
+/NEW_EVENT_NAME=INITIAL CONTACT ADJUSTED
+! /EVENT_INSTANCE=0
+! /RANGE_INSTANCE=0
+/EVENT_SEQUENCE=Gait Cycle
+! /EXCLUDE_EVENTS=
+;
+</code>