HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Global Minimum
visual3d:documentation:pipeline:event_commands:event_global_minimum

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:event_commands:event_global_minimum [2025/04/10 20:00] – wikisysopvisual3d:documentation:pipeline:event_commands:event_global_minimum [2025/04/28 17:50] (current) – [Dialog] wikisysop
Line 1: Line 1:
 ====== Event Global Minimum ====== ====== Event Global Minimum ======
  
-==== Overview ====+===== 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: 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**   * Search over the **entire trial**, or within a specific **event-defined interval**
Line 12: Line 12:
 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]].
  
-==== Pipeline Command ====+===== Pipeline Command =====
 The command below is as seen in the Visual3D application, **Version 6**. The command below is as seen in the Visual3D application, **Version 6**.
  
Line 34: Line 34:
 </code> </code>
  
-====Command Parameters====+=====Command Parameters=====
  
 The following table shows the command parameters and descriptions: The following table shows the command parameters and descriptions:
Line 41: Line 41:
 |**/RESULT_EVENT_NAME=**           | Name of the new event created at the signal's minimum value. | |**/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_TYPES=**               | Type of signal (e.g., `ANALOG`, `LINK_MODEL_BASED`, `TARGET`). |
-|**!/SIGNAL_FOLDER=**              | Folder where the signal is stored, usually `ORIGINAL` or `NORMALIZED`. |+|**!/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_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). | |**!/SIGNAL_COMPONENTS=**          | Component of the signal to check (e.g., X, Y, Z). |
Line 59: Line 59:
 {{:visual3d:documentation:pipeline:event_commands:egmin_dialog.png?500|}} {{:visual3d:documentation:pipeline:event_commands:egmin_dialog.png?500|}}
  
-====Examples==== +  * **New Event Label Name**: Name for event that will be created at the minimum point. 
-The following example will go through the use of the **Event_Global_Maximum** command in the Visual3D application.+  * **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===== 
 +The following example will go through the use of the **Event_Global_Minimum** command in the Visual3D application.
  
 This command may be used to create an event **RKFlex_Min**, at the GLOBAL minimum value of a signal.\\ This command may be used to create an event **RKFlex_Min**, at the GLOBAL minimum value of a signal.\\
Line 76: Line 88:
   * Event_Minimum command may be used to create multiple minimum events during an event sequence.   * Event_Minimum command may be used to create multiple minimum events during an event sequence.
  
-=== Example - Dialog Box ===+==== 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. 
  
 To create the RKFlex_Min event using the Event_Global_Minimum dialog box: To create the RKFlex_Min event using the Event_Global_Minimum dialog box:
  
-\\ 
  
 +**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>|
  
-|**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}}| 
  
-\\+**2. Select desired signal:** 
 +  * Select **signal from data tree** Right_Knee_Angle 
 +  * Click **Import Selected Signals** 
  
  
-|**2. Select desired signal:**\\ \\ Select **signal from data tree** Right_Knee_Angle\\ \\ Click **Import Selected Signals**  |  {{:Event_Global_Min_RKFlex_Min_Import.jpg}}|+{{:Event_Global_Min_RKFlex_Min_Import.jpg?700}}| 
  
-\\ 
 **RKFlex_Min** will be created at the global minimum value during the gait cycle.\\ **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. 
  
-\\+==== 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> 
 + 
 + 
 +----
  
 ====Notes==== ====Notes====
visual3d/documentation/pipeline/event_commands/event_global_minimum.1744315240.txt.gz · Last modified: 2025/04/10 20:00 by wikisysop