HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Minimum
visual3d:documentation:pipeline:event_commands:event_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_minimum [2025/04/28 16:52] – wikisysopvisual3d:documentation:pipeline:event_commands:event_minimum [2025/04/29 19:00] (current) – [Example 1] wikisysop
Line 8: Line 8:
   * 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]].
   * 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 it has a value or expression, only local minimum that are less than the threshold are identified.+  * If /THRESHOLD is empty, all local minimum are identified. If it has a value or expression, only local minimum that are less than the threshold are identified.
  
  
Line 35: Line 35:
 </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 57: Line 57:
 |**!/THRESHOLD=**                 | Minimum value required to qualify as a valid minimum.| |**!/THRESHOLD=**                 | Minimum value required to qualify as a valid minimum.|
  
-====Dialog====+=====Dialog=====
 This command can be used via text or the dialog interface. To open the dialog, double-click the command or click the **Edit** button in the pipeline editor. This command can be used via text or the dialog interface. To open the dialog, double-click the command or click the **Edit** button in the pipeline editor.
  
 {{:visual3d:documentation:pipeline:event_commands:event_min_dialog.png?400|}} {{:visual3d:documentation:pipeline:event_commands:event_min_dialog.png?400|}}
  
-  * Dropdowns for signal type, label, and folder. +  * **New Event Label Name**: Name of event created at the local minimum points. 
-  * Input boxes for frame window and event filtering. +  * **Signal Component**: Which direction of the signal to analyze. 
-  * Offset and threshold parameters for fine-tuning.+  * **Frame Window**: Size of window to look for a local minimum around each frame. 
 +  * **Frame Offset**: Shift the resulting event by a number of frames. 
 +  * **Time Offset**: Move the event by a time shift (in seconds) 
 +  * **Threshold**: Only create an event if the minimum exceeds this value. 
 +  * **Event Instance to Create**: Choose which minimum to create if there are multiple dipss in a search window 
 +  * **Event Sequence and Instance for Range**: Limits where to search for minima 
 +  * **Subsequence and Instance within Event Sequence**: Further limits search inside smaller phase within main event range.
  
-====Examples====+=====Examples=====
 The following examples will go through the use of the Event_Minimum command in the Visual3D application. The following examples will go through the use of the Event_Minimum command in the Visual3D application.
  
-===Example 1===+====Example 1====
  
 In the first example, we will create an event named RKFlex_MinLocal using the command. In the first example, we will create an event named RKFlex_MinLocal using the command.
Line 79: Line 85:
   * **Signal Components:** X   * **Signal Components:** X
   * **Event Sequence Instance:** 0   * **Event Sequence Instance:** 0
-  * **Defined Events:** RHS + RHS+  * Adjust frame window based on size of trials. (this example- 40 Frames)
  
 |{{:visual3d:documentation:pipeline:event_commands:eventmin_ex1_dialog.png?400|}}|<code> |{{:visual3d:documentation:pipeline:event_commands:eventmin_ex1_dialog.png?400|}}|<code>
Line 97: Line 103:
 ! /EVENT_SUBSEQUENCE_INSTANCE=0 ! /EVENT_SUBSEQUENCE_INSTANCE=0
 ! /EVENT_INSTANCE=0 ! /EVENT_INSTANCE=0
-! /FRAME_WINDOW=8+! /FRAME_WINDOW=40
 ! /THRESHOLD= ! /THRESHOLD=
 ; ;
Line 109: Line 115:
  
  
-**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:
  
-===Example 2===+|{{:visual3d:documentation:pipeline:event_commands:eventmin_ex1_correctgrph.png?600|}}| 
 + 
 + 
 +====Example 2====
  
 In this more complex example, we will delete the previously set RKFlex_MinLocal, instead we want to identify the minimum angle of the right knee ONLY during the swing phase AND only include minima that fall **below a functional threshold**, and extract the signal value at those minima. In this more complex example, we will delete the previously set RKFlex_MinLocal, instead we want to identify the minimum angle of the right knee ONLY during the swing phase AND only include minima that fall **below a functional threshold**, and extract the signal value at those minima.
Line 162: Line 171:
 ---- ----
  
-====Notes====+=====Notes=====
  
   * The `/FRAME_WINDOW=` must be an **odd number** (e.g., 7, 9, 11) to center the search correctly.   * The `/FRAME_WINDOW=` must be an **odd number** (e.g., 7, 9, 11) to center the search correctly.
Line 170: Line 179:
  
  
-===== Version 4 =====+==== Version 4 ====
  
-\\ 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}}
  
 \\ \\
visual3d/documentation/pipeline/event_commands/event_minimum.1745859162.txt.gz · Last modified: 2025/04/28 16:52 by wikisysop