Differences

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

--- visual3d:documentation:pipeline:event_commands:event_minimum [2024/06/26 20:04] – removed sgranger
+++ visual3d:documentation:pipeline:event_commands:event_minimum [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
+====== Event Minimum ======
+\\
+**Specify an Event Label(s) at the specified local minima of a signal.**
+**If the global minimum is needed, see the [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Global_Minimum|Event_Global_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]].
+|**Event_Minimum**\\ \\ /RESULT_EVENT_NAME=EVENT_MIN\\ \\ /SIGNAL_TYPES=TARGET\\ \\ /SIGNAL_FOLDER=ORIGINAL\\ \\ /SIGNAL_NAMES=LFT2\\ \\ /SIGNAL_COMPONENTS=Z\\ \\ /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\\ \\ /FRAME_WINDOW=8\\ \\ /THRESHOLD=0.14\\ \\ **;**|{{:EventMinimumDlg5.jpg}}|
+\\
+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_Minimum#Examples|Event_Global_Minimum]] page.
+If /Threshold is empty, all local minimum are identified.
+If /Threshold has a value or expression, only local minimum that are less than the threshold are identified.
+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_Minimum#Examples|Event_Global_Minimum]] page.
+----
+=== Example - Dialog Box ===
+To create the RKFlex_MinLocal event using the Event_Minimum dialog box:
+\\
+|**1. Enter information into dialog box:**\\ \\ **Event_Name:** RKFlex_MinLocal\\ \\ **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_Min_RKFlex_MinLocal.jpg}}|
+\\
+|**2. Select desired signal:**\\ \\ Select **signal from data tree** Right_Knee_Angle\\ \\ Click **Import Selected Signals**  |  {{:Event_Min_RKFlex_MinLocal_Import.jpg}}|
+\\
+**RKFlex_Min** will be created at the minimum value during the gait cycle within the specified frame window.\\
+\\
+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.
+----
+===== Version 4 =====
+|\\ \\ \\ <code>\\ Event_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\\ /Frame_Window=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\\ /Event_Instance=See below\\ ;\\ </code>  |  Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\ {{:MinMaxDlg.jpg}}  |
+\\
+**Event Instance:** There may be several local minima. A value of 0 results in all minima being assigned a label. A positive number indicates the event (in sequence) to select. A negative number indicates the event starting from the last event and progressing to the first event.\\