Differences

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

--- visual3d:documentation:pipeline:event_commands:event_global_minimum [2024/06/19 12:49] – sgranger
+++ visual3d:documentation:pipeline:event_commands:event_global_minimum [2025/04/28 17:50] (current) – [Dialog] wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{{{{{\\
+====== Event Global Minimum ======
-**specify an event label(s) at the global minimum of a signal.**
-**the result will be one minimum value over the range.**
+===== Overview =====
+This command identifies the lowest point (minimum value) of a signal within a specified time range and creates a corresponding event at that frame. It is typically used when a user wants to detect a **single lowest value** of a signal over an entire trial or within a specific interval defined by events. This command is highly configurable and allows you to:
+  * Search over the **entire trial**, or within a specific **event-defined interval**
+  * Use offsets to shift the created event slightly forward or backward in time/frames.
+  * Limit search to specific instances of repeated event sequence.
+  * Define nested ranges using subsequences.
-**if the local minima are needed, see the [[visual3d:documentation:pipeline:event_commands:event_minimum|event_minimum]] command\\
+If the local minima are needed, see the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Minimum|Event_Minimum]] command
-**\\
-to review the difference between local and global minimum values please see [[visual3d:documentation:pipeline:general_information:global_vs_loca_max_and_min|here]].
-====== version 6 ======
+To review the difference between local and global minimum values please see [[Visual3D:Documentation:Pipeline:General_Information:Global_vs_Loca_Max_and_Min|here]].
-the **event_global_minimum** command may be used to place an event at the global minimum value of a signal. if threshold has a value or expression only global minimum less than threshold will be identified.
+===== Pipeline Command =====
+The command below is as seen in the Visual3D application, **Version 6**.
-event_global_minimum_v6.png
+<code>
+Event_Global_Minimum
+/RESULT_EVENT_NAME=
+! /SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /SIGNAL_COMPONENTS=
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /THRESHOLD=
+;
+</code>
-\\
+=====Command Parameters=====
+The following table shows the command parameters and descriptions:
-====== version 5 ======
+|**Parameter**                     |**Description**|
+|**/RESULT_EVENT_NAME=**           | Name of the new event created at the signal's minimum value. |
+|**!/SIGNAL_TYPES=**               | Type of signal (e.g., `ANALOG`, `LINK_MODEL_BASED`, `TARGET`). |
+|**!/SIGNAL_FOLDER=**              | Folder where the signal is stored (usually `ORIGINAL` or `NORMALIZED`). |
+|**!/SIGNAL_NAMES=**               | The specific signal to evaluate (e.g., `Force`, `Left_Ankle_Angle`). |
+|**!/SIGNAL_COMPONENTS=**          | Component of the signal to check (e.g., X, Y, Z). |
+|**!/FRAME_OFFSET=**               | Number of frames to shift the new event from the minimum. |
+|**!/TIME_OFFSET=**                | Time (in seconds) to shift the event forward or backward. |
+|**!/EVENT_SEQUENCE=**             | Sequence of two events (e.g., `LTO`, `LHS`) to restrict the search range. |
+|**!/EXCLUDE_EVENTS=**             | If any listed event occurs in the sequence, it is skipped. |
+|**!/EVENT_SEQUENCE_INSTANCE=**   | Index of the sequence instance to evaluate (0 = all, 1 = first, etc.). |
+|**!/EVENT_SUBSEQUENCE=**          | Optional inner event window within a broader sequence. |
+|**!/SUBSEQUENCE_EXCLUDE_EVENTS=**| Exclude subsequence if certain events are present. |
+|**!/EVENT_SUBSEQUENCE_INSTANCE=**| Specify instance of the subsequence to evaluate. |
+|**!/THRESHOLD=**                  | Minimum required signal value to consider a point as the minimum. |
-place an event at the global minimum of a signal.
+====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 command. The dialog box is shown below:
-|<code>\\ event_global_minimum\\ /result_event_name=\\ ! /signal_types=\\ ! /signal_names=\\ ! /signal_folder=original\\ ! /signal_components=\\ ! /frame_offset=0\\ ! /time_offset=\\ ! /event_sequence=\\ ! /exclude_events=\\ ! /event_sequence_instance=0\\ ! /event_subsequence=\\ ! /subsequence_exclude_events=\\ ! /event_subsequence_instance=0\\ ! /event_instance=0\\ ! /select_x=\\ ! /select_y=\\ ! /select_z=\\ ! /select_residual=\\ ! /start_at_event=\\ ! /end_at_event=\\ ;\\ </code>  |  event_global_minimum.jpg|
+{{:visual3d:documentation:pipeline:event_commands:egmin_dialog.png?500|}}
+  * **New Event Label Name**: Name for event that will be created at the minimum point.
+  * **Signal Component**: Direction of signal to be analyzed.
+  * **Frame Offset**: Move the resulting event by a number of frames.
+  * **Time Offset**: Shift the event by time (in seconds).
+  * **Threshold**: Create an event if the minimum value is below this value.
+  * **Event Sequence and Instance for Range**: Search for the minimum between specific events.
+  * **Subsequence and Instance within Event Sequence**: Search window within the main sequence.
-----
-====== examples ======
-this command may be used to create an event, **rkflex_min**, at the global minimum value of a signal.\\
-) the minimum value of the signal may be over the entire signal\\
-) the minimum value of the signal may be during an event sequence\\
-) a specific event sequence may be excluded\\
-\\
+=====Examples=====
-create an event rkflex_min at the minimum knee flexion angle during the gait cycle. the gait cycle is indicated by the rhs events.\\
+The following example will go through the use of the **Event_Global_Minimum** command in the Visual3D application.
-**note:** if no events are specified in the event sequence, a global minimum over the whole trial will be created.\\
-\\
-one event will be created during each gait cycle.\\
-event_minimum command may be used to create multiple minimum events during an event sequence.\\
+This command may be used to create an event **RKFlex_Min**, at the GLOBAL minimum value of a signal.\\
-==== example - dialog box ====
+RKFlex_Min is at the minimum knee flexion angle during the gait cycle. The gait cycle is indicated by the RHS events.\\
-to create the rkflex_min event using the event_global_minimum dialog box:
+**Example 1)** The minimum value of the signal may be over the entire signal\\
+**Example 2)** The minimum value of the signal may be during an event sequence\\
+**Example 3)** A specific event sequence may be excluded\\
-\\
+**NOTE:**
+  * If no events are specified in the Event Sequence, a global minimum over the whole trial will be created.
+  * One event will be created during each gait cycle.
+  * Event_Minimum command may be used to create multiple minimum events during an event sequence.
-|**1. enter information into dialog box:**\\ \\ **event_name:** rkflex_min\\ \\ **select frame offset:**0\\ \\ **signal components:**x\\ \\ **select an event sequence and instance for the range:**\\ \\ **event sequence instance:**0\\ \\ **defined events:**rhs + rhs\\ \\ click **ok**  |  event_global_min_rkflex_min.jpg|
+==== Example 1: Simple Use Case ====
+This example will be done showing both the dialog box and corresponding command text.
-\\
+Other options within the command such as **Exclude Event**, and **Select Subsequence** are explained in detail on the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Global_Maximum#Examples|Event_Global_Maximum]] page.
-|**2. select desired signal:**\\ \\ select **signal from data tree** right_knee_angle\\ \\ click **import selected signals**  |  event_global_min_rkflex_min_import.jpg|
+To create the RKFlex_Min event using the Event_Global_Minimum dialog box:
-\\
-**rkflex_min** will be created at the global minimum value during the gait cycle.\\
-\\
-other options within the command such as **exclude event**, and **select subsequence** are explained in detail on the [[visual3d:documentation:pipeline:event_commands:event_global_maximum#examples|event_global_maximum]] page.
-\\
+**1. Enter information into dialog box:**
+  * **Event_Name:** RKFlex_Min
+  * **Select Frame Offset:** 0
+  * **Signal Components:** X
+  * **Event Sequence Instance:** 0
+  * **Defined Events:** RHS + RHS
+  * Click **OK**
+|{{:visual3d:documentation:pipeline:event_commands:dialog_ex1_egmin.png?500|}}|<code>
+Event_Global_Minimum
+/RESULT_EVENT_NAME=RKFlex_Min
+! /SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+/SIGNAL_COMPONENTS=X
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+/EVENT_SEQUENCE=RHS+RHS
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /THRESHOLD=
+;
+</code>|
+**2. Select desired signal:**
+  * Select **signal from data tree** Right_Knee_Angle
+  * Click **Import Selected Signals**
+{{:Event_Global_Min_RKFlex_Min_Import.jpg?700}}|
+**RKFlex_Min** will be created at the global minimum value during the gait cycle.\\
+==== Example 2: Finding Value at Event ====
+This command can be used to find the **lowest vertical GRF during swing phase** of the left leg (right single support) and convert that to a metric.
+<code>
+Event_Global_Minimum
+/RESULT_EVENT_NAME=RMinGRF
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAME=Right GRF
+/FRAME_OFFSET=0
+! /TIME_OFFSET=
+/EVENT_SEQUENCE=LTO+LHS
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=
+! /EVENT_SUBSEQUENCE
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /THRESHOLD=
+;
+</code>
+Then find the metric value at this event for the GRF:
+<code>
+Metric_Signal_Value_At_Event
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAME=Right GRF
+/RESULT_METRIC_NAME=minGRF
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+! /SIGNAL_COMPONENTS=
+! /COMPONENT_SEQUENCE=
+/EVENT_NAME=RMinGRF
+! /EVENT_INSTANCE=0
+;
+</code>
 ----
-====== version 4 ======
+====Notes====
+=== Version 5 ===
-specify an event label(s) at the global minimum of a signal.
+|{{:Event_Global_Minimum.jpg}}|<code>
+Event_Global_Minimum
+/RESULT_EVENT_NAME=
+! /SIGNAL_TYPES=
+! /SIGNAL_NAMES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_COMPONENTS=
+! /FRAME_OFFSET=0
+! /TIME_OFFSET=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+! /EVENT_SEQUENCE_INSTANCE=0
+! /EVENT_SUBSEQUENCE=
+! /SUBSEQUENCE_EXCLUDE_EVENTS=
+! /EVENT_SUBSEQUENCE_INSTANCE=0
+! /EVENT_INSTANCE=0
+! /SELECT_X=
+! /SELECT_Y=
+! /SELECT_Z=
+! /SELECT_RESIDUAL=
+! /START_AT_EVENT=
+! /END_AT_EVENT=
+;
+</code>|
-|\\ \\ \\ <code>\\ event_global_minimum\\ /signal_types= the type of signal to be evaluated\\ /signal_names= the names of the signals to be evaluated\\ /signal_folder= the name of the signal folder\\ /event_name= the name to be given to the threshold event\\ /select_x= (true or false)use this component of the signal\\ /select_y= (true or false)use this component of the signal\\ /select_z= (true or false)use this component of the signal\\ /radius= the range of frames of data that must be below the minimum\\ /start_at_event= the search begins from the start event\\ /end_at_event= the search ends at the end event\\ ;\\ </code>  |  dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\ eventglobalminmaxdlg.gif  |
+=== Version 4 ===
+|{{:Eventglobalminmaxdlg.gif}}|<code>
+Event_Global_Minimum
+/Signal_Types= The type of signal to be evaluated
+/Signal_Names= The names of the signals to be evaluated
+/Signal_Folder= The name of the signal folder
+/Event_Name= The name to be given to the threshold event
+/Select_X= (True or False)Use this component of the signal
+/Select_Y= (True or False)Use this component of the signal
+/Select_Z= (True or False)Use this component of the signal
+/Radius= The range of frames of data that must be below the minimum
+/Start_At_Event= The search begins from the start event
+/End_At_Event= The search ends at the end event
+;
+</code>|
-}}}}}}}}}}