Differences

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

--- visual3d:documentation:pipeline:event_commands:event_minimum [2024/06/19 12:49] – 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\\
+\\
+**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]].
+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|
+|**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.
+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 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.
+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.
+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 ====
+=== Example - Dialog Box ===
-to create the rkflex_minlocal event using the event_minimum 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|
+|**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|
+|**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.\\
+**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.
+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 ======
+===== 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  |
+|\\ \\ \\ <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.\\
+**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.\\
-}}}}}}}}