Differences

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

--- visual3d:documentation:pipeline:event_commands:event_modify [2024/06/19 12:49] – sgranger
+++ visual3d:documentation:pipeline:event_commands:event_modify [2025/04/28 19:06] (current) – wikisysop
@@ Line 1: / Line 1: @@
-\\
+====== Event Modify ======
+===== Overview =====
+The **Event_Modify** command is used to adjust the timing of existing events by modifying their frame or time values. This command is useful for refining event placement, correcting errors, or aligning events with a new reference point. Users can modify events based on either frame numbers or time values.
-==== modify_event ====
+This command is particularly useful when event markers need to be fine-tuned based on updated analysis criteria or when synchronizing events with other signals.
-the name of the legacy command. visual3d should continue to recognize this command.
+**Note**: All times will be rounded to nearest POINT frame.
+===== Pipeline Command =====
+The command below is as seen in the Visual3D application.
+<code>
+Event_Modify
+/EVENT_NAME=
+! /OLD_FRAME=
+! /NEW_FRAME=
+! /OLD_TIME=
+! /NEW_TIME=
+;
+</code>
+===== Command Parameters =====
+The following table shows the command parameters and descriptions:
+|**Parameter**   |**Description**|
+|**/EVENT_NAME=**|The name of the event to be modified.|
+|**!/OLD_FRAME=**|The original frame number of the event before modification.|
+|**!/NEW_FRAME=**|The new frame number to assign to the event.|
+|**!/OLD_TIME=**|The original time (in seconds) of the event before modification.|
+|**!/NEW_TIME=**|The new time (in seconds) to assign to the event.|
+===== 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_Modify** command in the Visual3D application.
+==== Example 1: Modifying an Event by Time Value ====
+This example adjusts the RHS event from 1.28 seconds to 2 seconds. You can check the "Old Time" of an event by left clicking on it within the data tree. This dialog shows the time value we are changing:
+{{:visual3d:documentation:pipeline:event_commands:datavalues_rhs.png?400|}}
+Apply the command:
+<code>
+Event_Modify
+/EVENT_NAME=RHS
+! /OLD_FRAME=
+! /NEW_FRAME=
+/OLD_TIME=1.28
+/NEW_TIME=2
+;
+</code>
+After running this pipeline, we can see from the dialog again that the time of the event now displays as 2 seconds.
+==== Example 2: Combine in a workflow with Event Detection ====
+We can find the maximum left hip angle throughout the full trial. Let's say we want any values 5 seconds following the max:
+<code>
+/RESULT_EVENT_NAME=LMaxHip
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=L Hip Angle
+/SIGNAL_COMPONENTS=Y
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /THRESHOLD=
+;
+</code>
+Next, we can use the **Metric_Explicit** command to define the time when the LMaxHip event label is placed.
+<code>
+Metric_Explicit
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=Time_of_LMaxHip
+/METRIC_VALUE=EVENT_LABEL::ORIGINAL::LMaxHip
+</code>
+Finally, the command can be used to add 5 frames to the time of the Max Hip Angle.
+<code>
+Event_Modify
+/EVENT_NAME=LMaxHip
+! /OLD_FRAME=
+/NEW_FRAME= Time_of_LMaxHip + 5
+! /OLD_TIME=
+! /NEW_TIME=
+</code>
+----