HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Threshold
visual3d:documentation:pipeline:event_commands:event_threshold

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_threshold [2025/02/27 19:14] – wikisysopvisual3d:documentation:pipeline:event_commands:event_threshold [2025/04/29 13:39] (current) – [Dialog] wikisysop
Line 1: Line 1:
 ====== Event Threshold ====== ====== Event Threshold ======
  
-==== Overview ==== +===== Overview ===== 
-The **Event_Threshold** command is used to detect threshold crossings (when signal crosses a specified value) in biomechanical signals and label events accordingly. This command provides extensive control over event placement by allowing users to define frame or time offsets, include or exclude sequences, and refine detections using component selection and event constraints.+The **Event_Threshold** command is used to detect threshold crossings (when signal crosses a specified value) in a signals and label events accordingly. This command provides extensive control over event placement by allowing users to define frame or time offsets, include or exclude sequences, and refine detections using component selection and event constraints.
  
 This command is particularly useful for defining critical events based on signal thresholds, such as peak force occurrences, velocity changes, or acceleration-based triggers. This command is particularly useful for defining critical events based on signal thresholds, such as peak force occurrences, velocity changes, or acceleration-based triggers.
Line 8: Line 8:
 **Note**: The threshold parameter specified can be a number, a PROCESSED METRIC, or an expression. **Note**: The threshold parameter specified can be a number, a PROCESSED METRIC, or an expression.
  
-==== Pipeline Command ====+===== Pipeline Command =====
 The command below is as seen on the Visual3D application, it has many parameters as there are many options to manipulate this command. The command below is as seen on the Visual3D application, it has many parameters as there are many options to manipulate this command.
  
Line 36: Line 36:
 </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 61: Line 61:
 |**!/ENSURE_FRAMES_AFTER=FALSE**|(True or False) Radius frames of data after crossing must lie on the same side of the threshold.| |**!/ENSURE_FRAMES_AFTER=FALSE**|(True or False) Radius frames of data after crossing must lie on the same side of the threshold.|
  
-==== Dialog ====+===== 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 pipeline command. The dialog is shown below. 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 pipeline command. The dialog is shown below.
  
 {{:visual3d:documentation:pipeline:event_commands:event_thr_dialog.png?400|}} {{:visual3d:documentation:pipeline:event_commands:event_thr_dialog.png?400|}}
  
-==== Examples ====+  * **New Event Label Name**: Name to assign event that reaches threshold value. 
 +  * **Signal Component**: Direction of signal to use (X, Y, Z, ALL) 
 +  * **Frame Window**: Number of frames to check for threshold condition. 
 +  * **Frame Offset**: Shift event by a specified number of frames. 
 +  * **Time Offset**: Shift event by time (in seconds). 
 +  * **Threshold**: Value the signal must cross to trigger the event. 
 +  * **Event Instance**: Specify which instance of the event to label. (0 = all) 
 +  * **Label on Ascent/Descent**: Choose to place event when threshold is cross in an increasing signal (ascent) or decreasing signal (descent). 
 +  * **Ensure Window Before/After**: Full frame window is available before or after detected point to avoid errors. 
 +  * **Event Sequence**: Specify range in which to search for threshold crossings. 
 +  * **Event Subsequence**: Specify subrange in which to search for threshold crossings. 
 + 
 + 
 + 
 + 
 +===== Examples =====
 The following examples will go through the use of the Event_Threshold command in the Visual3D application. The following examples will go through the use of the Event_Threshold command in the Visual3D application.
  
-=== Example 1: Detecting Peak Ground Reaction Force ===+==== Example 1: Detecting Peak Ground Reaction Force ====
 This example uses the **Event_Threshold** command to detect the event Max_GRF when the vertical ground reaction force (GRF_Z) crosses 1000N in the ascending direction: This example uses the **Event_Threshold** command to detect the event Max_GRF when the vertical ground reaction force (GRF_Z) crosses 1000N in the ascending direction:
  
Line 97: Line 112:
 </code> </code>
  
-=== Example 2: Maintaining Event Window after Threshold Closing ===+==== Example 2: Maintaining Event Window after Threshold Closing ====
 In this example, the events **FP3_Y** and **FP3_Y_ENSURE** are created using the command. The event **FP3_Y_ENSURE** will use the "Ensure Window After" option within the dialog box, which guarantees that the event window remains open for a specified duration after the triggering condition is met.  In this example, the events **FP3_Y** and **FP3_Y_ENSURE** are created using the command. The event **FP3_Y_ENSURE** will use the "Ensure Window After" option within the dialog box, which guarantees that the event window remains open for a specified duration after the triggering condition is met. 
  
Line 165: Line 180:
 </code> </code>
  
-== Result ==+=== Result ===
 After running this pipeline, you will notice 3 events have been created: After running this pipeline, you will notice 3 events have been created:
   * 2 instances of **FP3_Y**, crosses the threshold (0.05) two times during the trial.   * 2 instances of **FP3_Y**, crosses the threshold (0.05) two times during the trial.
Line 173: Line 188:
  
  
-==== Notes ====+===== Notes =====
  
 === Visual3D Versions supporting Subject Prefixes === === Visual3D Versions supporting Subject Prefixes ===
visual3d/documentation/pipeline/event_commands/event_threshold.1740683697.txt.gz · Last modified: 2025/02/27 19:14 by wikisysop