visual3d:documentation:pipeline:event_commands:event_onset
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
visual3d:documentation:pipeline:event_commands:event_onset [2025/02/26 18:30] – wikisysop | visual3d:documentation:pipeline:event_commands:event_onset [2025/04/28 19:47] (current) – [Dialog] wikisysop | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Event Onset ====== | ====== Event Onset ====== | ||
- | ==== Overview ==== | + | ===== Overview |
The **Event_Onset** command is used to detect and label an event when a specified signal crosses a defined threshold. This command allows users to analyze motion signals by specifying a threshold, direction of crossing, and optional baseline conditions. The event can be applied to individual signal components and constrained within a specified frame window or event range. | The **Event_Onset** command is used to detect and label an event when a specified signal crosses a defined threshold. This command allows users to analyze motion signals by specifying a threshold, direction of crossing, and optional baseline conditions. The event can be applied to individual signal components and constrained within a specified frame window or event range. | ||
The command creates an event label at either the last minimum value before a threshold crossing, or at the last baseline threshold. THe closest event is set as the ONSET event. Some key details are as follows: | The command creates an event label at either the last minimum value before a threshold crossing, or at the last baseline threshold. THe closest event is set as the ONSET event. Some key details are as follows: | ||
* The threshold crossing is a fairly high value (or metric) that the user is confident is beyond the Event of interest. | * The threshold crossing is a fairly high value (or metric) that the user is confident is beyond the Event of interest. | ||
- | * The baseline crossing is a low threshold value (or metric) which is typically the point at which a velocity signal(for example) just starts moving. | + | * The baseline crossing is a low threshold value (or metric) which is typically the point at which a velocity signal (for example) just starts moving. |
* The last local minimum before the threshold crossing (higher threshold). | * The last local minimum before the threshold crossing (higher threshold). | ||
* The event from the baseline crossing and local minimum that is closest to the higher threshold crossing is set as the ONSET Event. | * The event from the baseline crossing and local minimum that is closest to the higher threshold crossing is set as the ONSET Event. | ||
* If multiple components are chosen (X Y and Z), the command will look for when any component passes the threshold and when any component reaches the baseline or a local minimum. | * If multiple components are chosen (X Y and Z), the command will look for when any component passes the threshold and when any component reaches the baseline or a local minimum. | ||
- | ==== Pipeline Command ==== | + | ===== Pipeline Command |
The command below is as seen in the Visual3D application. | The command below is as seen in the Visual3D application. | ||
Line 35: | Line 35: | ||
</ | </ | ||
- | ==== Command Parameters ==== | + | ===== Command Parameters |
The following table shows the command parameters and descriptions: | The following table shows the command parameters and descriptions: | ||
Line 53: | Line 53: | ||
|**!/ | |**!/ | ||
- | ==== 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. | ||
{{: | {{: | ||
- | ==== Examples ==== | + | * **Event Name**: Name for the new event that will be created. |
+ | * **X, Y, Z Checkboxes**: | ||
+ | * **Threshold**: | ||
+ | * **Threshold Instance**: Defines how many threshold crossings to detect. | ||
+ | * **Baseline**: | ||
+ | * **Frame Offset**: Number of frames to shift event. | ||
+ | * **Frame Window**: Sets a window of frames to search for threshold crossing. | ||
+ | * **Label on Ascent/ | ||
+ | * Find Event within Range - limits for threshold crossings. | ||
+ | ===== Examples | ||
The following examples will go through the use of the Event_Onset command in the Visual3D application. | The following examples will go through the use of the Event_Onset command in the Visual3D application. | ||
- | === Example 1 === | + | ==== Example 1 ==== |
This example identifies movement onset based on the speed of the hand. It detects the onset of hand movement (labeled as " | This example identifies movement onset based on the speed of the hand. It detects the onset of hand movement (labeled as " | ||
Line 88: | Line 97: | ||
==== Example 2 ==== | ==== Example 2 ==== | ||
+ | The following command is designed to automatically detect and label an event named " | ||
< | < | ||
Line 118: | Line 128: | ||
+ | ===== Notes ===== | ||
+ | * The /Ascending and /Descending parameters determine whether the event is placed at an upward or downward threshold crossing. | ||
+ | * The / | ||
+ | * The /Baseline is useful when detecting minima or maxima, ensuring the event is placed correctly. | ||
visual3d/documentation/pipeline/event_commands/event_onset.1740594627.txt.gz · Last modified: 2025/02/26 18:30 by wikisysop